update pull request checklist

[zacharyburnett]

using points from @nden 's email

old checklist

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

• 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
• All comments are resolved
• Make sure the JIRA ticket is resolved properly

new checklist

Tasks

• request a review from someone specific, to avoid making the maintainers review every PR
• add a build milestone, i.e. Build 11.3 (use the latest build if not sure)
• Does this PR change user-facing code / API?
  • add an entry to CHANGES.rst within the relevant release section (otherwise add the no-changelog-entry-needed label to this PR)
  • update or add relevant tests
  • update relevant docstrings and / or docs/ page
  • start a regression test and include a link to the running job (click here for instructions)
    • Do truth files need to be updated ("okified")?
      • after the reviewer has approved these changes, run okify_regtests to update the truth files
• if a JIRA ticket exists, make sure it is resolved properly

[zacharyburnett]

new pull request checklist looks like this:

Tasks

• request a review from someone specific, to avoid making the maintainers review every PR
• add a build milestone, i.e. Build 11.3 (use the latest build if not sure)
• Does this PR change user-facing code / API?
  • add an entry to CHANGES.rst within the relevant release section (otherwise add the no-changelog-entry-needed label to this PR)
  • update or add relevant tests
  • update relevant docstrings and / or docs/ page
  • start a regression test and include a link to the running job
    • Do truth files need to be updated ("okified")?
      • after the reviewer has approved these changes, run okify_regtests to update the truth files
• if a JIRA ticket exists, make sure it is resolved properly

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.83%. Comparing base (19d46a0) to head (542b3ce).

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #8670      +/-   ##
==========================================
+ Coverage   60.73%   60.83%   +0.09%     
==========================================
  Files         373      373              
  Lines       38624    38636      +12     
==========================================
+ Hits        23458    23503      +45     
+ Misses      15166    15133      -33     

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

[melanieclarke]

A couple questions/comments:

• Can we make it clear that these are tasks for PR authors who are also pipeline developers? Some of these tasks can't be done without developer permissions on the repo - we should still note that, or separate those out, so external PR authors are not confused.
• Can we link to the docs for "start a regression test" instead of, or in addition to, the workflow page?

[zacharyburnett]

A couple questions/comments:

• Can we make it clear that these are tasks for PR authors who are also pipeline developers? Some of these tasks can't be done without developer permissions on the repo - we should still note that, or separate those out, so external PR authors are not confused.
• Can we link to the docs for "start a regression test" instead of, or in addition to, the workflow page?

How's this:

Tasks

• request a review from someone specific, to avoid making the maintainers review every PR
• add a build milestone, i.e. Build 11.3 (use the latest build if not sure)
• Does this PR change user-facing code / API?
  • add an entry to CHANGES.rst within the relevant release section (otherwise add the no-changelog-entry-needed label to this PR)
  • update or add relevant tests
  • update relevant docstrings and / or docs/ page
  • start a regression test and include a link to the running job (click here for instructions)
    • Do truth files need to be updated ("okified")?
      • after the reviewer has approved these changes, run okify_regtests to update the truth files
• if a JIRA ticket exists, make sure it is resolved properly

[melanieclarke]

That looks better. Thanks!

[nden]

@zacharyburnett I'm approving this and assuming you will take care of the item about CHANGES.rst when towncrier is enabled.