diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..b2080be --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,29 @@ +============ +Contributing +============ + +Developing +========== + +1. Fork the repo on GitHub. +2. Clone your fork locally. +3. Install your local copy into a virtual environment. +4. Create a branch for local development. Use the naming convention + `feature/{{name-of-feature}}` for features and `bugfix/{{name-of-bug}}` for + bugfixes. +5. Implement the feature/bugfix. Write tests that prove your implementation + works as intended. +6. Once your feature is implemented run the complete test suite using `tox`. +7. Push the changes to your GitHub repository. +8. Submit a pull request to the original repository using the GitHub website. + + +Pull Request Guidelines +======================= + +Before you submit a pull request, check that it meets these guidelines: + +1. The pull request should include tests. +2. If the pull request adds functionality, the docs should be updated. +3. Make sure the complete test suite passes. Use `tox` to verify it on your + local machine.