diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 6327780e..14370caa 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -12,14 +12,19 @@ Closes # This PR addresses ... -**Checklist** - -- [ ] for a public change, added a towncrier news fragment in `changes/`:
`echo "changed something" > changes/..rst` - - - ``changes/.apichange.rst``: change to public API - - ``changes/.bugfix.rst``: fixes an issue - - ``changes/.general.rst``: infrastructure or miscellaneous change -- [ ] updated relevant tests -- [ ] updated relevant documentation -- [ ] updated relevant milestone(s) -- [ ] added relevant label(s) + +## Tasks +- [ ] update or add relevant tests +- [ ] update relevant docstrings and / or `docs/` page +- [ ] Does this PR change any API used downstream? (if not, label with `no-changelog-entry-needed`) + - [ ] write news fragment(s) in `changes/`: `echo "changed something" > changes/..rst` (see below for change types) + - [ ] run regression tests with this branch installed (`"git+https://github.com//stcal@"`) + - [ ] [`jwst` regression test](https://github.com/spacetelescope/RegressionTests/actions/workflows/jwst.yml) + - [ ] [`romancal` regression test](https://github.com/spacetelescope/RegressionTests/actions/workflows/romancal.yml) + +
news fragment change types... + +- ``changes/.apichange.rst``: change to public API +- ``changes/.bugfix.rst``: fixes an issue +- ``changes/.general.rst``: infrastructure or miscellaneous change +