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

[Enhancement]: Write recipe for quick PR review #592

Open
1 task done
taylorbell57 opened this issue Dec 13, 2023 · 0 comments
Open
1 task done

[Enhancement]: Write recipe for quick PR review #592

taylorbell57 opened this issue Dec 13, 2023 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@taylorbell57
Copy link
Collaborator

taylorbell57 commented Dec 13, 2023

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 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

  • I agree to follow this project's Code of Conduct
@taylorbell57 taylorbell57 added the enhancement New feature or request label Dec 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: To do
Development

No branches or pull requests

2 participants