Skip to content

docs: add code coverage goals to test/README.md #4978

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.

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

khushi-2503
Copy link

docs: add code coverage documentation to test README #4952

This PR adds a section on code coverage to test/README.md to help contributors understand the coverage goals and how to check coverage locally.

Changes:
Added a Code Coverage section explaining:

1.The 80% coverage goal

2.How to run coverage locally using pytest --cov

3.Where to view Codecov reports

4.Notes on functional and branch coverage
Related Issue:
Closes #4952

Copy link
Contributor

@terriko terriko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just in case you missed the automated linter checks: you'll need to add "cov" to the dictionary (in .github/actions/spelling/allow.txt) before this can be merged.

@terriko terriko changed the title Update README.md docs: add code coverage goals to test/README.md Apr 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: add code coverage documentation to test README
2 participants