From 7ea6e0aec29878b3de67ea1ac3b620dfcc7bcea8 Mon Sep 17 00:00:00 2001
From: Zach Burnett <zburnett@stsci.edu>
Date: Tue, 24 Sep 2024 12:09:21 -0400
Subject: [PATCH] update pull request checklist (#1336)

---
 .github/pull_request_template.md | 73 +++++++++++++++++---------------
 1 file changed, 40 insertions(+), 33 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index eff267329..cd4983131 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -8,38 +8,45 @@ Closes #
 <!-- describe the changes comprising this PR here -->
 This PR addresses ...
 
-**Checklist**
-- [ ] for a public change, added a towncrier news fragment in `changes/` <details><summary>`echo "changed something" > changes/<PR#>.<changetype>.rst`</summary>
+<!-- if you can't perform these due to permissions, please ask a maintainer to do them -->
+## Tasks
+- [ ] **request a review from someone specific**, to avoid making the maintainers review every PR
+- [ ] add a build milestone, i.e. `24Q4_B15` (use the [latest build](https://github.com/spacetelescope/romancal/milestones) if not sure)
+- [ ] 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)
+  - [ ] update or add relevant tests
+  - [ ] update relevant docstrings and / or `docs/` page
+  - [ ] [start a regression test](https://github.com/spacetelescope/RegressionTests/actions/workflows/romancal.yml) and include a link to the running job ([click here for instructions](https://github.com/spacetelescope/RegressionTests/blob/main/docs/running_regression_tests.md))
+    - [ ] 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](https://github.com/spacetelescope/romancal/wiki/How-to-resolve-JIRA-issues)
 
-    - ``changes/<PR#>.general.rst``: infrastructure or miscellaneous change
-    - ``changes/<PR#>.docs.rst``
-    - ``changes/<PR#>.stpipe.rst``
-    - ``changes/<PR#>.associations.rst``
-    - ``changes/<PR#>.scripts.rst``
-    - ``changes/<PR#>.mosaic_pipeline.rst``
-    - ``changes/<PR#>.patch_match.rst``
+<details><summary>news fragment change types...</summary>
 
-    ## steps
-    - ``changes/<PR#>.dq_init.rst``
-    - ``changes/<PR#>.saturation.rst``
-    - ``changes/<PR#>.refpix.rst``
-    - ``changes/<PR#>.linearity.rst``
-    - ``changes/<PR#>.dark_current.rst``
-    - ``changes/<PR#>.jump_detection.rst``
-    - ``changes/<PR#>.ramp_fitting.rst``
-    - ``changes/<PR#>.assign_wcs.rst``
-    - ``changes/<PR#>.flatfield.rst``
-    - ``changes/<PR#>.photom.rst``
-    - ``changes/<PR#>.flux.rst``
-    - ``changes/<PR#>.source_detection.rst``
-    - ``changes/<PR#>.tweakreg.rst``
-    - ``changes/<PR#>.skymatch.rst``
-    - ``changes/<PR#>.outlier_detection.rst``
-    - ``changes/<PR#>.resample.rst``
-    - ``changes/<PR#>.source_catalog.rst``
-  </details>
-- [ ] updated relevant tests
-- [ ] updated relevant documentation
-- [ ] updated relevant milestone(s)
-- [ ] added relevant label(s)
-- [ ] ran regression tests, post a link to the Jenkins job below. [How to run regression tests on a PR](https://github.com/spacetelescope/romancal/wiki/Running-Regression-Tests-Against-PR-Branches)
+  - ``changes/<PR#>.general.rst``: infrastructure or miscellaneous change
+  - ``changes/<PR#>.docs.rst``
+  - ``changes/<PR#>.stpipe.rst``
+  - ``changes/<PR#>.associations.rst``
+  - ``changes/<PR#>.scripts.rst``
+  - ``changes/<PR#>.mosaic_pipeline.rst``
+  - ``changes/<PR#>.patch_match.rst``
+
+  ## steps
+  - ``changes/<PR#>.dq_init.rst``
+  - ``changes/<PR#>.saturation.rst``
+  - ``changes/<PR#>.refpix.rst``
+  - ``changes/<PR#>.linearity.rst``
+  - ``changes/<PR#>.dark_current.rst``
+  - ``changes/<PR#>.jump_detection.rst``
+  - ``changes/<PR#>.ramp_fitting.rst``
+  - ``changes/<PR#>.assign_wcs.rst``
+  - ``changes/<PR#>.flatfield.rst``
+  - ``changes/<PR#>.photom.rst``
+  - ``changes/<PR#>.flux.rst``
+  - ``changes/<PR#>.source_detection.rst``
+  - ``changes/<PR#>.tweakreg.rst``
+  - ``changes/<PR#>.skymatch.rst``
+  - ``changes/<PR#>.outlier_detection.rst``
+  - ``changes/<PR#>.resample.rst``
+  - ``changes/<PR#>.source_catalog.rst``
+</details>