To make things easier for Kevin and I (and all users who want to submit a PR), we should write a PR template similar to our Issue templates that makes gathering the minimum information simpler.
Also can look at the template text used by the jwst repo:
<!-- If this PR closes a JIRA ticket, make sure the title starts with the JIRA issue number,
for example JP-1234: <Fix a bug> -->
Resolves [JP-nnnn](https://jira.stsci.edu/browse/JP-nnnn)
<!-- If this PR closes a GitHub issue, reference it here by its number -->
Closes #
<!-- describe the changes comprising this PR here -->
This PR addresses ...
**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](https://github.com/spacetelescope/jwst/wiki/Running-Regression-Tests-Against-PR-Branches)
- [ ] Make sure the JIRA ticket is [resolved properly](https://github.com/spacetelescope/jwst/wiki/How-to-resolve-JIRA-issues)
Some things we may want in our checklist include:
Checked flake8 locally
Ran tests locally
Added any new citations
Code of Conduct
[X] I agree to follow this project's Code of Conduct
Instrument
Other (any stage)
What is your suggestion?
To make things easier for Kevin and I (and all users who want to submit a PR), we should write a PR template similar to our Issue templates that makes gathering the minimum information simpler.
We likely want to write a PR template using the info from this website: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository
Also can look at the template text used by the
jwstrepo:Some things we may want in our checklist include:
Code of Conduct