Skip to content

Commit

Permalink
DOC: Create CONTRIBUTING instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
carterbox authored Jan 20, 2017
1 parent 1307ec7 commit 4da4304
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 4da4304

Please sign in to comment.