summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorBen Firshman <ben@firshman.co.uk>2016-10-18 18:50:21 +0200
committerBen Firshman <ben@firshman.co.uk>2016-11-22 17:03:04 +0000
commited959f2144ed4719113cc4a570cd58ac0cca25da (patch)
tree4530c5c7103c2fc980e81543db2b5f7c8215eb68 /CONTRIBUTING.md
parentd98a8790163d3e3cdc15a43c9f981d28af1003d2 (diff)
downloaddocker-py-ed959f2144ed4719113cc4a570cd58ac0cca25da.tar.gz
Move contributing docs to CONTRIBUTING.md
CONTRIBUTING.md is the place that GitHub expects it to be. Signed-off-by: Ben Firshman <ben@firshman.co.uk>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 1bd8d42..dbc1c02 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,5 +1,8 @@
# Contributing guidelines
+See the [Docker contributing guidelines](https://github.com/docker/docker/blob/master/CONTRIBUTING.md).
+The following is specific to docker-py.
+
Thank you for your interest in the project. We look forward to your
contribution. In order to make the process as fast and streamlined as possible,
here is a set of guidelines we recommend you follow.
@@ -100,3 +103,34 @@ here are the steps to get you started.
5. Run `python setup.py develop` to install the dev version of the project
and required dependencies. We recommend you do so inside a
[virtual environment](http://docs.python-guide.org/en/latest/dev/virtualenvs)
+
+## Running the tests & Code Quality
+
+To get the source source code and run the unit tests, run:
+```
+$ git clone git://github.com/docker/docker-py.git
+$ cd docker-py
+$ pip install tox
+$ tox
+```
+
+## Building the docs
+
+```
+$ make docs
+$ open _build/index.html
+```
+
+## Release Checklist
+
+Before a new release, please go through the following checklist:
+
+* Bump version in docker/version.py
+* Add a release note in docs/change_log.md
+* Git tag the version
+* Upload to pypi
+
+## Vulnerability Reporting
+For any security issues, please do NOT file an issue or pull request on github!
+Please contact [security@docker.com](mailto:security@docker.com) or read [the
+Docker security page](https://www.docker.com/resources/security/).