diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..f11939b --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,45 @@ +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 or an guest guest as to where the problem may be occurring + +Pull Requests +------------- + +When creating a pull request, try to: + +- Write tests if applicable +- Note important changes in the `CHANGES`_ file +- Update the `README`_ file if needed +- Add yourself to the `AUTHORS`_ file + +.. _AUTHORS: AUTHORS.rst +.. _CHANGES: CHANGES.rst +.. _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):: + + ./runtests.sh