Skip to content
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

Jump to bottom

DOC: Update contributing documentation with code coverage details #60010

Open
1 task done
d33bs opened this issue Oct 9, 2024 · 3 comments · May be fixed by #60029
Open
1 task done

DOC: Update contributing documentation with code coverage details #60010

d33bs opened this issue Oct 9, 2024 · 3 comments · May be fixed by #60029
Labels
Docs

Comments

@d33bs
Copy link

d33bs commented Oct 9, 2024

Pandas version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

https://pandas.pydata.org/docs/development/contributing_codebase.html

Documentation problem

Thanks for the great work on Pandas! I was interested in finding out how Pandas measures code coverage and found that there doesn't seem to be much content yet on how to do this for the project. There's a dead link at https://pandas-coverage-12d2130077bc.herokuapp.com/ for the link mentioned in the content (tip: you can use the [pandas-coverage app](https://pandas-coverage-12d2130077bc.herokuapp.com/)).

I also noticed there's a codecov.yml file in the project so I looked this up manually by viewing: https://app.codecov.io/github/pandas-dev/pandas . This looks like a nice way to measure code coverage for the project which has already been configured, but isn't already mentioned within documentation (perhaps in addition to the already mentioned tool, once the link is fixed).

Suggested fix for documentation

I suggest adding the Codecov link somewhere in the contributing documentation and fixing the broken link for the pandas-coverage app (multiple measurements / perspectives could be helpful).
@d33bs d33bs added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Oct 9, 2024
@mroeschke mroeschke removed the Needs Triage Issue that has not been reviewed by a pandas team member label Oct 9, 2024
@mroeschke
Copy link
Member

The dead link was removed in #59536 (the docs will update during the next minor release), but sure a link to the codecov dashboard would be OK.

@d33bs
Copy link
Author

d33bs commented Oct 9, 2024

Thanks @mroeschke ! Apologies about not catching that the dead link was removed in the latest docs.

May I work towards adding content for the Codecov mention through a PR? If so, as a double check, would it make sense to mention any special patterns with concerns to how this impacts development for Pandas specifically?

@mroeschke
Copy link
Member

May I work towards adding content for the Codecov mention through a PR?

Sure

If so, as a double check, would it make sense to mention any special patterns with concerns to how this impacts development for Pandas specifically?

The Codecov report doesn't impact the development workflow currently (it would be nice to eventually enforce a minimum coverage). Linking to this would just be purely informational

@d33bs d33bs linked a pull request Oct 13, 2024 that will close this issue
Open
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add information about code coverage to docs d33bs/pandas
2 participants
@d33bs @mroeschke