🧪🎨 Enforce empty trivial change notes #12854
Draft
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
This is a preparatory step for further adding of new changelog fragment types.
Said commit is a formatting change.
Previously, the change log had a section called "Process". And some of
the incoming pull requests would add change notes there when they
couldn't be put into other categories. Using it like that is not a
good idea. This patch rethinks the categorization and the audiences of
a few common change types and defines respective categories that
replace "Process".
The new categories are:
* `packaging` -- news for downstream re-packagers
* `contrib` -- news for regular project participants
* `misc` -- public change log for things that don't fit anywhere but
are useful
Resolves pypa#12555
This is what the contribution document is asking for but the automation never checked really. Which led to contributors filling out trivial changelog entries without realizing that they are never published. The patch corrects that and relocates the violating change notes to better sections.
webknjaz
force-pushed
the
maintenance/towncrier-empty-trivial
branch
from
5cfd158
to
508083b
Compare
|
N.B. This PR includes commits from #12853. I'll rebase it, once that one is in. |
|
I don't think we should do this -- having contributors include information in this file is not harmful and it also makes it clearer that the contributor clearly understands both the tone as well as purpose of the notes. |
|
@pradyunsg are you commenting on the last commit? If yes — I don't understand why linting should let people put things into |
|
@pradyunsg can we deal with #12853 first, so the diff here could be smaller? |
webknjaz
commented
Jul 21, 2024
| |contrib | ||
| |misc | ||
| |trivial | ||
| )(.#)?(.rst)? |
There was a problem hiding this comment.
Suggested change
| )(.#)?(.rst)? | |
| )(.#)?.rst |
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.
This is what the contribution document is asking for but the
automation never checked really. Which led to contributors filling
out trivial changelog entries without realizing that they are never
published.
The patch corrects that and relocates the violating change notes to
better sections.