-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
cc045ac
commit a246d31
Showing
1 changed file
with
51 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,51 @@ | ||
Contributing | ||
============ | ||
|
||
Below is a list of tips for submitting issues and pull requests. These are | ||
suggestions and not requirements. | ||
|
||
Submitting Issues | ||
----------------- | ||
|
||
Issues are often easier to reproduce/resolve when they have: | ||
|
||
- A pull request with a failing test demonstrating the issue | ||
- A code example that produces the issue consistently | ||
- A traceback (when applicable) | ||
|
||
Pull Requests | ||
------------- | ||
|
||
When creating a pull request, try to: | ||
|
||
- Write tests if applicable | ||
- Update the `README`_ file if needed | ||
- Update the documentation if needed | ||
|
||
.. _README: README.rst | ||
|
||
Testing | ||
------- | ||
|
||
Please add tests for your code and ensure existing tests don't break. To run | ||
the tests against your code:: | ||
|
||
python setup.py test | ||
|
||
Please use tox to test the code against supported Python and Django versions. | ||
First install tox:: | ||
|
||
pip install tox | ||
|
||
To run tox and generate a coverage report (in ``htmlcov`` directory):: | ||
|
||
make test | ||
|
||
Generating documentation | ||
------------------------ | ||
|
||
To regenerate the documentation use:: | ||
|
||
make docs | ||
|
||
The generated documentation HTML files can be found in ``docs/_build/html``. |