Skip to content

Commit f770bee

Browse files
authored
Add information about code coverage to docs (#60029)
* add information about code coverage to docs * linting
1 parent fc3aff4 commit f770bee

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

doc/source/development/contributing_codebase.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -298,6 +298,12 @@ So, before actually writing any code, you should write your tests. Often the te
298298
taken from the original GitHub issue. However, it is always worth considering additional
299299
use cases and writing corresponding tests.
300300

301+
We use `code coverage <https://en.wikipedia.org/wiki/Code_coverage>`_ to help understand
302+
the amount of code which is covered by a test. We recommend striving to ensure code
303+
you add or change within Pandas is covered by a test. Please see our
304+
`code coverage dashboard through Codecov <https://app.codecov.io/github/pandas-dev/pandas>`_
305+
for more information.
306+
301307
Adding tests is one of the most common requests after code is pushed to pandas. Therefore,
302308
it is worth getting in the habit of writing tests ahead of time so this is never an issue.
303309

0 commit comments

Comments
 (0)