mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-07-24 05:36:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

[1.4.X] Fixed #16817 - Added a guide of code coverage to contributing docs.

Browse source 
Thanks Pedro Lima for the draft patch.

Backport of 06f5da3d78 from master
This commit is contained in:
Tim Graham 2012-10-11 06:11:52 -04:00
parent 1be0515fe9
commit 3ac70a5907
5 changed files with 31 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/internals/contributing/writing-code/unit-tests.txt
View file

@ -165,6 +165,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