|
| 1 | +Contributing |
| 2 | +============ |
| 3 | + |
| 4 | +Contributions of code and documentation are always welcome! |
| 5 | + |
| 6 | + |
| 7 | +Submitting Issues |
| 8 | +----------------- |
| 9 | + |
| 10 | +Issues are easier to reproduce and resolve when they include: |
| 11 | + |
| 12 | +- A pull request with a failing test demonstrating the issue (no need to file |
| 13 | + both a pull request and an issue, the pull request is sufficient). |
| 14 | +- A code example that produces the issue consistently |
| 15 | +- A traceback (when applicable) |
| 16 | + |
| 17 | + |
| 18 | +Pull Requests |
| 19 | +------------- |
| 20 | + |
| 21 | +When creating a pull request, try to: |
| 22 | + |
| 23 | +- Write tests that fail before your change and pass after it |
| 24 | +- Note important changes in the `CHANGES`_ file |
| 25 | +- Update the `README`_ file as needed |
| 26 | +- Add yourself to the `AUTHORS`_ file |
| 27 | + |
| 28 | +.. _AUTHORS: AUTHORS.rst |
| 29 | +.. _CHANGES: CHANGES.rst |
| 30 | +.. _README: README.rst |
| 31 | + |
| 32 | + |
| 33 | +Testing |
| 34 | +------- |
| 35 | + |
| 36 | +Please add tests for your code and ensure existing tests don't break. To run |
| 37 | +the tests against your code:: |
| 38 | + |
| 39 | + python setup.py test |
| 40 | + |
| 41 | +You can use `tox`_ to test the code against supported Python and Django |
| 42 | +versions. First install tox:: |
| 43 | + |
| 44 | + pip install tox |
| 45 | + |
| 46 | +To run tests using tox:: |
| 47 | + |
| 48 | + tox |
| 49 | + |
| 50 | +To fully run the tests via tox, you must have python2.6, python2.7, and |
| 51 | +python3.3 interpreters on your system, available by those names. If you are |
| 52 | +missing one or more interpreters, tox will skip testing against that Python |
| 53 | +version and notify you. |
| 54 | + |
| 55 | +When submitting a pull request, please note whether you've run the tests with |
| 56 | +tox (and against which versions). Before a pull request can be merged, all |
| 57 | +tests must pass on all configured tox environments. |
| 58 | + |
| 59 | +.. _tox: http://tox.readthedocs.org/en/latest/ |
0 commit comments