improve pull request template checklist #1854
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zacharyburnett
commented
Oct 29, 2024
Comment on lines
-30
to
+44
| - [ ] pre-commit checks ran successfully | ||
| - [ ] tests ran successfully | ||
| - [ ] for a public change, added a [towncrier news fragment](https://towncrier.readthedocs.io/en/stable/tutorial.html#creating-news-fragments) <details><summary>`changes/<PR#>.<changetype>.rst`</summary> | ||
| - [ ] [run `pre-commit` on your machine](https://pre-commit.com/#quick-start) | ||
| - [ ] run `pytest` on your machine | ||
| - [ ] Does this PR add new features and / or change user-facing code / API? (if not, label with `no-changelog-entry-needed`) | ||
| - [ ] write news fragment(s) in `changes/`: `echo "changed something" > changes/<PR#>.<changetype>.rst` (see below for change types) | ||
| - [ ] update relevant docstrings and / or `docs/` page | ||
| - [ ] for any new features, add unit tests | ||
|
|
||
| - ``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#>.general.rst``: infrastructure or miscellaneous change | ||
| </details> | ||
| - [ ] for a public change, updated documentation | ||
| - [ ] for any new features, unit tests were added | ||
| <details><summary>news fragment change types...</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#>.general.rst``: infrastructure or miscellaneous change | ||
| </details> |
There was a problem hiding this comment.
old checklist:
-
pre-commit checks ran successfully
-
tests ran successfully
-
for a public change, added a towncrier news fragment
changes/<PR#>.<changetype>.rstchanges/<PR#>.feature.rst: new featurechanges/<PR#>.bugfix.rst: bug fixchanges/<PR#>.doc.rst: documentation changechanges/<PR#>.removal.rst: deprecation or removal of public APIchanges/<PR#>.general.rst: infrastructure or miscellaneous change
-
for a public change, updated documentation
-
for any new features, unit tests were added
new checklist:
- run
pre-commiton your machine - run
pyteston your machine - Does this PR add new features and / or change user-facing code / API? (if not, label with
no-changelog-entry-needed)- write news fragment(s) in
changes/:echo "changed something" > changes/<PR#>.<changetype>.rst(see below for change types) - update relevant docstrings and / or
docs/page - for any new features, add unit tests
- write news fragment(s) in
news fragment change types...
changes/<PR#>.feature.rst: new featurechanges/<PR#>.bugfix.rst: bug fixchanges/<PR#>.doc.rst: documentation changechanges/<PR#>.removal.rst: deprecation or removal of public APIchanges/<PR#>.general.rst: infrastructure or miscellaneous change
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The current pull request checklist is formatted a bit wonky (
detailsspaces out the task list)Tasks
pre-commiton your machinepyteston your machineno-changelog-entry-needed)changes/:echo "changed something" > changes/<PR#>.<changetype>.rst(see below for change types)docs/pagenews fragment change types...
changes/<PR#>.feature.rst: new featurechanges/<PR#>.bugfix.rst: bug fixchanges/<PR#>.doc.rst: documentation changechanges/<PR#>.removal.rst: deprecation or removal of public APIchanges/<PR#>.general.rst: infrastructure or miscellaneous change