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

clarify checklist in PR template #8466

Merged
merged 4 commits into from
May 8, 2024

Conversation

braingram
Copy link
Collaborator

@braingram braingram commented May 7, 2024

This PR changes maintainers to PR authors in the PR template to clarify who should fill out the checklist. I never thought it was me :)

This PR also adds a new item to the checklist:

  • All comments are resolved

Checklist for maintainers

  • [ ] added entry in CHANGES.rst within the relevant release section
  • [ ] updated or added relevant tests
  • [ ] updated relevant documentation
  • added relevant milestone
  • added relevant label(s)
  • [ ] ran regression tests, post a link to the Jenkins job below.
    How to run regression tests on a PR
  • [ ] Make sure the JIRA ticket is resolved properly

@braingram braingram requested a review from a team as a code owner May 7, 2024 15:42
@github-actions github-actions bot added the automation Continuous Integration (CI) and testing automation tools label May 7, 2024
@braingram braingram requested a review from hbushouse May 7, 2024 15:54
Copy link

codecov bot commented May 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 56.54%. Comparing base (6580914) to head (2fe1df6).
Report is 10 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #8466      +/-   ##
==========================================
+ Coverage   56.38%   56.54%   +0.16%     
==========================================
  Files         387      387              
  Lines       38716    38785      +69     
==========================================
+ Hits        21830    21932     +102     
+ Misses      16886    16853      -33     

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

@@ -8,12 +8,15 @@ Closes #
<!-- describe the changes comprising this PR here -->
This PR addresses ...

**Checklist for maintainers**
**Checklist for PR authors**
Copy link
Collaborator

Choose a reason for hiding this comment

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

We sometimes get PRs from developers external to the organization who don't have permission to set labels or milestones. But if maintainers was confusing I agree it should be changed. May be qualify it with

Checklist for PR authors (skip items if you don't have permissions):

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Should we split this into 2 checklists? 1 for items that require permissions which I think are:

  • milestones
  • regression tests
  • labels (although these should get set automatically)
    and one for the PR author (the remaining items).

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks! I modified the wording based on your suggestion to hopefully resolve this comment (see db6f096):

**Checklist for PR authors (skip items if you don't have permissions or they are not applicable)**

@nden hopefully this doesn't change your approval. If all looks good to you and @hbushouse feel free to merge.

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

@hbushouse hbushouse left a comment

Choose a reason for hiding this comment

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

Works for me.

@hbushouse hbushouse merged commit 4e91a1c into spacetelescope:master May 8, 2024
27 of 28 checks passed
@braingram braingram deleted the pr_template branch May 8, 2024 20:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation Continuous Integration (CI) and testing automation tools no-changelog-entry-needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants