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

Update PR template #468

Merged
merged 5 commits into from
Sep 15, 2023
Merged

Update PR template #468

merged 5 commits into from
Sep 15, 2023

Conversation

cyschneck
Copy link
Contributor

@cyschneck cyschneck commented Sep 13, 2023

PR Summary

Closes #455

Changes to the PR template (.github/PULL_REQUEST_TEMPLATE.md):

  • remove item about tagging the entire NCAR/geocat team
  • update link to contributor's guide (depends on Contributor's Guide #450)
  • add a note to squash and merge if appropriate for cleaning up commit history
  • "remove link to non-existent "documentation standards" on geocat website" -> set to Docstrings description in contributions docstrings
  • Reword the "add summary here" comment at top to indicate a written summary should be added in the section in addition to noting the corresponding issue

PR Checklist

General

  • Make an issue if one doesn't already exist
  • Link the issue this PR resolves by adding closes #XXX to the PR description where XXX is the number of the issue.
  • Add a brief summary of changes to docs/release-notes.rst
  • Add appropriate labels to this PR
  • Make your changes in a forked repository rather than directly in this repo
  • Open this PR as a draft if it is not ready for review
  • Convert this PR from a draft to a full PR before requesting reviewers
  • [n/a] Request @NCAR/geocat for reviews
  • [n/a] Passes precommit. To set up on your local, run pre-commit install from the top level of the repository. To manually run pre-commits, use pre-commit run --all-files and re-add any changed files before committing again and pushing.

@cyschneck cyschneck self-assigned this Sep 13, 2023
@cyschneck cyschneck added the documentation Improvements or additions to documentation label Sep 13, 2023
@cyschneck cyschneck marked this pull request as ready for review September 13, 2023 16:44
@@ -8,12 +8,12 @@ apply to this PR, comment it out or delete it. -->
**General**
- [ ] Make an issue if one doesn't already exist
- [ ] Link the issue this PR resolves by adding `closes #XXX` to the PR description where XXX is the number of the issue.
- [ ] Add a brief summary of changes to `docs/release-notes.rst`
- [ ] If needed, squash and merge PR commits into a single commit to clean up commit history
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small point, but could we put the squash and merge item last in the general section?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated!

@anissa111 anissa111 self-requested a review September 13, 2023 22:15
@anissa111 anissa111 merged commit fa3fa12 into NCAR:main Sep 15, 2023
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update PR template
2 participants