From 6aa6ba0667f49dea0e71d4ec1cca93d3d67f302c Mon Sep 17 00:00:00 2001 From: Trey Hunner Date: Mon, 20 May 2013 22:58:08 -0700 Subject: [PATCH 1/2] Add a CONTRIBUTING file --- CONTRIBUTING.rst | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 CONTRIBUTING.rst 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 From 6716e45ccd25a2c6e93fcbb82802332571a7bdff Mon Sep 17 00:00:00 2001 From: Trey Hunner Date: Thu, 25 Jul 2013 09:45:36 -0700 Subject: [PATCH 2/2] Fixup CONTRIBUTING file per Carl's suggestions --- CONTRIBUTING.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index f11939b..70d48bb 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -11,7 +11,7 @@ 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 +- A traceback (when applicable) Pull Requests ------------- @@ -43,3 +43,6 @@ First install tox:: To run tox and generate a coverage report (in ``htmlcov`` directory):: ./runtests.sh + +**Please note**: Before a pull request can be merged, all tests must pass and +code/branch coverage in tests must be 100%.