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.

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

update checklist for new pull requests #288

Merged

Conversation

zacharyburnett
Copy link
Collaborator

@zacharyburnett zacharyburnett commented Sep 10, 2024

restructure the pull request checklist to be more useful and less clunky

old checklist

Checklist

  • for a public change, added a towncrier news fragment in changes/:

    echo "changed something" > changes/<PR#>.<changetype>.rst

    • changes/<PR#>.apichange.rst: change to public API
    • changes/<PR#>.bugfix.rst: fixes an issue
    • changes/<PR#>.general.rst: infrastructure or miscellaneous change
  • updated relevant tests

  • updated relevant documentation

  • updated relevant milestone(s)

  • added relevant label(s)

new checklist

Tasks

  • update or add relevant tests
  • update relevant docstrings and / or docs/ page
  • Does this PR change user-facing code / API? (if not, label with no-changelog-entry-needed)
    • write news fragment(s) in changes/: echo "changed something" > changes/<PR#>.<changetype>.rst (see below for change types)
    • run regression tests with this branch installed ("git+https://github.com/<fork>/stcal@<branch>")
news fragment change types...
  • changes/<PR#>.apichange.rst: change to public API
  • changes/<PR#>.bugfix.rst: fixes an issue
  • changes/<PR#>.general.rst: infrastructure or miscellaneous change

Copy link

codecov bot commented Sep 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.65%. Comparing base (d85f859) to head (53e7393).
Report is 14 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #288      +/-   ##
==========================================
+ Coverage   84.63%   84.65%   +0.02%     
==========================================
  Files          41       41              
  Lines        7628     7651      +23     
==========================================
+ Hits         6456     6477      +21     
- Misses       1172     1174       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@zacharyburnett zacharyburnett marked this pull request as ready for review September 10, 2024 14:39
@zacharyburnett zacharyburnett requested a review from a team as a code owner September 10, 2024 14:39
Copy link
Collaborator

@braingram braingram left a comment

Choose a reason for hiding this comment

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

Sorry for the double review, I noticed the "add tests" was also under the "public change" subsection. We want all the tests!

.github/pull_request_template.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@braingram braingram left a comment

Choose a reason for hiding this comment

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

LGTM.

@zacharyburnett zacharyburnett merged commit c3e1332 into spacetelescope:main Sep 11, 2024
24 of 25 checks passed
@zacharyburnett zacharyburnett deleted the update/pull_request_template branch September 11, 2024 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants