Skip to content

Add information about code coverage to docs #60029

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 29, 2024
Merged

Add information about code coverage to docs #60029

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c4186cd
add information about code coverage to docs
d33bs Oct 12, 2024
700f251
linting
d33bs Oct 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/source/development/contributing_codebase.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,12 @@ So, before actually writing any code, you should write your tests. Often the te
taken from the original GitHub issue. However, it is always worth considering additional
use cases and writing corresponding tests.

We use `code coverage <https://en.wikipedia.org/wiki/Code_coverage>`_ to help understand
the amount of code which is covered by a test. We recommend striving to ensure code
you add or change within Pandas is covered by a test. Please see our
`code coverage dashboard through Codecov <https://app.codecov.io/github/pandas-dev/pandas>`_
for more information.

Adding tests is one of the most common requests after code is pushed to pandas. Therefore,
it is worth getting in the habit of writing tests ahead of time so this is never an issue.

Expand Down
Loading