Skip to content

Commit 4da4304

Browse files
authored
DOC: Create CONTRIBUTING instructions.
1 parent 1307ec7 commit 4da4304

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Before making a pull request, please follow these steps:
2+
3+
1. If you are adding a new feature, [open an issue](https://github.com/tomography/xdesign/issues) explaining what you want to add.
4+
2. Use [pycodstyle](https://pypi.python.org/pypi/pycodestyle) or something similar to check for PEP8 compliance.
5+
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.
6+
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 commit comments

Comments
 (0)