diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6425a79 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,6 @@ +Before making a pull request, please follow these steps: + +1. If you are adding a new feature, [open an issue](https://github.com/tomography/xdesign/issues) explaining what you want to add. +2. Use [pycodstyle](https://pypi.python.org/pypi/pycodestyle) or something similar to check for PEP8 compliance. +3. Create new tests for your new code and pass the existing tests by calling [nosetests](http://nose.readthedocs.io/en/latest/index.html) on the tests directory. +4. Document your code with [reST](http://www.sphinx-doc.org/en/1.5.1/rest.html) because we use `Sphinx` to generate our documentation.