id	summary	reporter	owner	description	type	status	component	version	severity	resolution	keywords	cc	stage	has_patch	needs_docs	needs_tests	needs_better_patch	easy	ui_ux
16817	Add a guide on code coverage to contributing docs	Julien Phalip	Pedro Lima	"Increasing code coverage is a good place to start for new contributors to get acquainted both with the Django codebase and with its test suite. Python core has a nice guide for it `[1]` and it'd be useful for Django to have one too. The guide would explain how to install the `coverage.py` module, run it on top of the `runtests` script, generate the reports, etc.:

{{{
$ coverage run ./runtests.py --settings=test_sqlite
$ coverage html
}}}

Some embedded third-party modules should be excluded so as to not mess up the results. This exclusion would be facilitated by adding a configuration file to `django/tests/` (see attachment).

It would also be useful to have a regularly-updated online report that one could easily refer to. There's already one on the CI server `[2]`, which is a great start, although it is using Cobertura instead of `coverage.py`.

`[1]` http://docs.python.org/devguide/coverage.html

`[2]` http://ci.django-cms.org/job/Django%20Coverage/cobertura"	Cleanup/optimization	closed	Documentation	1.3	Normal	fixed		preston@… Pedro Lima	Accepted	1	0	0	1	1	0