Update whatsnew instructions for GitHub #98124
Merged
Conversation
This file contains hidden or 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
Member
|
There is a template for Whatsnew in the release-tools repo used by release managers. |
ezio-melotti
approved these changes
Oct 9, 2022
carljm
added a commit
to carljm/release-tools
that referenced
this pull request
Oct 10, 2022
Use `:gh:` instead of `:issue:`, clarify that it should be the GH issue number, and remove Mercurial reference. See python/cpython#98124 for the first two changes in 3.12 whatsnew.
Member
Author
|
Submitted python/release-tools#24 to also update the template for future releases. |
mpage
pushed a commit
to mpage/cpython
that referenced
this pull request
Oct 11, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Since all new changes will have a github issue, recommend
:gh:rather than:issue:in whatsnew instruction block.Also clarify "bug/patch number" to "issue number" -- this also (subtly) clarifies that it is the issue, not the PR, that should be linked.
I didn't find a "whatsnew template" anywhere (by grepping for text in this header block that is common to all recent whatsnew files), so I assume new ones are created by copying the most recent one, thus editing
3.12.rstis the right approach.