Skip to content

Commit

Permalink
update pull request template to include collapsed explanation of chan…
Browse files Browse the repository at this point in the history
…ge log entry types
  • Loading branch information
zacharyburnett committed Aug 20, 2024
1 parent 04cc885 commit a99b1c9
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,13 @@ If this PR fixes an issue, please add closing keywords (eg 'fixes #XXX')

- [ ] pre-commit checks ran successfully
- [ ] tests ran successfully
- [ ] for a public change, added news fragment (`changes/<PR#>.<changetype>.rst`)
- [ ] for a public change, added <details><summary>news fragment (`changes/<PR#>.<changetype>.rst`)</summary>

- ``changes/<PR#>.feature.rst``: new feature
- ``changes/<PR#>.bugfix.rst``: bug fix
- ``changes/<PR#>.doc.rst``: documentation change
- ``changes/<PR#>.removal.rst``: deprecation or removal of public API
- ``changes/<PR#>.misc.rst``: not of interest to users; use an empty file
</details>
- [ ] for a public change, updated documentation
- [ ] for any new features, unit tests were added

0 comments on commit a99b1c9

Please sign in to comment.