-
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
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
📝💅 Split trivial change log category into 3 #12501
📝💅 Split trivial change log category into 3 #12501
Conversation
6955ad6
to
a506c06
Compare
FTR, some of the reasoning/justification is present in this external discussion: pypa/pip#12555. |
a506c06
to
94d3289
Compare
should this backport? |
This patch makes them more verbose so that they are clearer to the readers.
94d3289
to
bea6522
Compare
The new change note types are `packaging`, `contrib` and `misc`. `packaging` is intended for the audience of downstream redistributors. The `contrib` notes are meant to be documenting news affecting the project contributors, their development, and processes. Finally, `misc` is for things that don't fit anywhere but are still desired to be documented for some reason.
bea6522
to
e73db68
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❤️
FYI the preview for this PR's change note is rendered @ https://pytest--12501.org.readthedocs.build/en/12501/changelog.html#contributor-facing-changes. |
Backport to 8.2.x: 💔 cherry-picking failed — conflicts found❌ Failed to cleanly apply b08b6d1 on top of patchback/backports/8.2.x/b08b6d122fa82994b70f5dc1437c936d0e97ada7/pr-12501 Backporting merged PR #12501 into main
🤖 @patchback |
…og-categories 📝💅 Split trivial change log category into 3 (cherry picked from commit b08b6d1)
Manual backport PR: #12506 |
[PR #12501/b08b6d1 backport][8.2.x] 📝💅 Split trivial change log category into 3
The new change note types are
packaging
,contrib
andmisc
.packaging
is intended for the audience of downstream redistributors.The
contrib
notes are meant to be documenting news affecting theproject contributors, their development, and processes.
Finally,
misc
is for things that don't fit anywhere but are stilldesired to be documented for some reason.
This patch additionally extends the change log title meanings, making them more verbose and clearer to the
readers. Plus, it adds comment annotations in the Towncrier configuration.