diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 29 |
1 files changed, 14 insertions, 15 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dbc1c02..8617311 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,7 @@ # Contributing guidelines See the [Docker contributing guidelines](https://github.com/docker/docker/blob/master/CONTRIBUTING.md). -The following is specific to docker-py. +The following is specific to Docker SDK for Python. 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, @@ -10,13 +10,14 @@ here is a set of guidelines we recommend you follow. ## Reporting issues We do our best to ensure bugs don't creep up in our releases, but some may -still slip through. If you encounter one while using docker-py, please create -an issue [in the tracker](https://github.com/docker/docker-py/issues/new) with +still slip through. If you encounter one while using the SDK, please +create an issue +[in the tracker](https://github.com/docker/docker-py/issues/new) with the following information: -- docker-py version, docker version and python version +- SDK version, Docker version and python version ``` -pip freeze | grep docker-py && python --version && docker version +pip freeze | grep docker && python --version && docker version ``` - OS, distribution and OS version - The issue you're encountering including a stacktrace if applicable @@ -24,14 +25,14 @@ pip freeze | grep docker-py && python --version && docker version To save yourself time, please be sure to check our [documentation](https://docker-py.readthedocs.io/) and use the -[search function](https://github.com/docker/docker-py/search) to find out if -it has already been addressed, or is currently being looked at. +[search function](https://github.com/docker/docker-py/search) to find +out if it has already been addressed, or is currently being looked at. ## Submitting pull requests Do you have a fix for an existing issue, or want to add a new functionality -to docker-py? We happily welcome pull requests. Here are a few tips to make -the review process easier on both the maintainers and yourself. +to the SDK? We happily welcome pull requests. Here are a few tips to +make the review process easier on both the maintainers and yourself. ### 1. Sign your commits @@ -87,11 +88,10 @@ to reach out and ask questions. We will do our best to answer and help out. ## Development environment -If you're looking contribute to docker-py but are new to the project or Python, -here are the steps to get you started. +If you're looking contribute to Docker SDK for Python but are new to the +project or Python, here are the steps to get you started. -1. Fork [https://github.com/docker/docker-py](https://github.com/docker/docker-py) - to your username. +1. Fork https://github.com/docker/docker-py to your username. 2. Clone your forked repository locally with `git clone git@github.com:yourusername/docker-py.git`. 3. Configure a @@ -110,8 +110,7 @@ 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 +$ make test ``` ## Building the docs |