-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DOC: Create CONTRIBUTING instructions.
- Loading branch information
Showing
1 changed file
with
6 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |