-
Notifications
You must be signed in to change notification settings - Fork 3k
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 the "process" change log entry to 3 #12853
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -110,8 +110,8 @@ public is concerned, typo fixes, white space modification, etc. To mark a PR | |
as trivial a contributor simply needs to add a randomly named, empty file to | ||
the ``news/`` directory with the extension of ``.trivial.rst``. If you are on a | ||
POSIX like operating system, one can be added by running | ||
``touch news/$(uuidgen).trivial.rst``. On Windows, the same result can be | ||
achieved in Powershell using ``New-Item "news/$([guid]::NewGuid()).trivial.rst"``. | ||
``touch news/+$(uuidgen).trivial.rst``. On Windows, the same result can be | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @sbidoul FYI, fragments with the leading There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. TIL. Thanks! |
||
achieved in Powershell using ``New-Item "news/+$([guid]::NewGuid()).trivial.rst"``. | ||
Core committers may also add a "skip news" label to the PR which will accomplish | ||
the same thing. | ||
|
||
|
@@ -126,6 +126,25 @@ otherwise notable can be done using a ``news/<name>.process.rst`` file. This is | |
not typically used, but can be used for things like changing version schemes, | ||
updating deprecation policy, etc. | ||
|
||
Changes to the packaging metadata and tooling of pip itself should be documented | ||
in :file:`news/{<name>}.packaging.rst` files. This can include notes for | ||
downstreams about unobvious side effects and tooling, as well as changes in the | ||
test invocation considerations and runtime assumptions. | ||
|
||
When your change is something that influence how contributors and core | ||
committers interact with the project, record that and actionable updates via a | ||
:file:`news/{<name>}.contrib.rst` file. Stuff that affects the contributor | ||
experience, like running tests, building the docs, setting up the development | ||
environment would go here. It's useful for occasional contributors to learn the | ||
gist of what's changed since the last time they were active. | ||
|
||
If you feel like that your change would affect the end-users in noticeable ways | ||
but it's difficult to assign any of the above categories to it, it is possible | ||
to add a :file:`news/{<name>}.misc.rst` file to still present the change's | ||
effect in the change log. Unlike :file:`news/{<name>}.trivial.rst` entries, this | ||
change log fragment type will show up publicly in the released change log | ||
document. | ||
|
||
|
||
Updating your branch | ||
==================== | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,29 @@ | ||
* | ||
!.gitignore | ||
!*.bugfix | ||
!*.bugfix.rst | ||
!*.bugfix.*.rst | ||
!*.contrib | ||
!*.contrib.rst | ||
!*.contrib.*.rst | ||
!*.doc | ||
!*.doc.rst | ||
!*.doc.*.rst | ||
!*.feature | ||
!*.feature.rst | ||
!*.feature.*.rst | ||
!*.misc | ||
!*.misc.rst | ||
!*.misc.*.rst | ||
!*.packaging | ||
!*.packaging.rst | ||
!*.packaging.*.rst | ||
!*.removal | ||
!*.removal.rst | ||
!*.removal.*.rst | ||
!*.trivial | ||
!*.trivial.rst | ||
!*.trivial.*.rst | ||
!*.trivial | ||
!*.vendor.rst | ||
!*.vendor.*.rst |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
12853.contrib.rst |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
Added separate changelog fragment types for contributor- | ||
and downstream-facing patches, as well as a catch-all | ||
miscellaneous section. | ||
|
||
Their corresponding identifiers are ``contrib`` and ``packaging`` | ||
respectively. They are meant to be used for more accurate | ||
classification, where one would resort to using ``misc`` otherwise. |
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.