diff options
| author | Ben Firshman <ben@firshman.co.uk> | 2016-10-18 18:50:21 +0200 |
|---|---|---|
| committer | Ben Firshman <ben@firshman.co.uk> | 2016-11-22 17:03:04 +0000 |
| commit | ed959f2144ed4719113cc4a570cd58ac0cca25da (patch) | |
| tree | 4530c5c7103c2fc980e81543db2b5f7c8215eb68 /docs | |
| parent | d98a8790163d3e3cdc15a43c9f981d28af1003d2 (diff) | |
| download | docker-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 'docs')
| -rw-r--r-- | docs/contributing.md | 36 |
1 files changed, 0 insertions, 36 deletions
diff --git a/docs/contributing.md b/docs/contributing.md deleted file mode 100644 index e776458..0000000 --- a/docs/contributing.md +++ /dev/null @@ -1,36 +0,0 @@ -# Contributing -See the [Docker contributing guidelines](https://github.com/docker/docker/blob/master/CONTRIBUTING.md). -The following is specific to docker-py. - -## 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 -Docs are built with [MkDocs](http://www.mkdocs.org/). For development, you can -run the following in the project directory: -``` -$ pip install -r docs-requirements.txt -$ mkdocs serve -``` - -## 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/). |