diff options
author | Tim Graham <timograham@gmail.com> | 2012-10-11 06:11:52 -0400 |
---|---|---|
committer | Tim Graham <timograham@gmail.com> | 2012-10-11 06:11:52 -0400 |
commit | 06f5da3d7813e9a23b1e98ecf8b75fc6073800e9 (patch) | |
tree | b452f60b10ad562b9b241afac7914a1cfce78ea6 /docs/internals/contributing | |
parent | 7ef2781ca0ce48872e21dce2f322c9e4106d1cfd (diff) | |
download | django-06f5da3d7813e9a23b1e98ecf8b75fc6073800e9.tar.gz |
Fixed #16817 - Added a guide of code coverage to contributing docs.
Thanks Pedro Lima for the draft patch.
Diffstat (limited to 'docs/internals/contributing')
-rw-r--r-- | docs/internals/contributing/writing-code/unit-tests.txt | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/internals/contributing/writing-code/unit-tests.txt b/docs/internals/contributing/writing-code/unit-tests.txt index 4de506a654..a828b06b36 100644 --- a/docs/internals/contributing/writing-code/unit-tests.txt +++ b/docs/internals/contributing/writing-code/unit-tests.txt @@ -163,6 +163,26 @@ associated tests will be skipped. .. _gettext: http://www.gnu.org/software/gettext/manual/gettext.html .. _selenium: http://pypi.python.org/pypi/selenium +Code coverage +~~~~~~~~~~~~~ + +Contributors are encouraged to run coverage on the test suite to identify areas +that need additional tests. The coverage tool installation and use is described +in :ref:`testing code coverage<topics-testing-code-coverage>`. + +To run coverage on the Django test suite using the standard test settings:: + + coverage run ./runtests.py --settings=test_sqlite + +After running coverage, generate the html report by running:: + + coverage html + +When running coverage for the Django tests, the included ``.coveragerc`` +settings file defines ``coverage_html`` as the output directory for the report +and also excludes several directories not relevant to the results +(test code or external code included in Django). + .. _contrib-apps: Contrib apps |