Skip to content

Commit d627164

Browse files
BethGriggstargos
authored andcommitted
doc: clarify semver-minor notable changes approach
Clarifies the current approach taken by releasers when crafting notable changes for releases. This approach is also in line with the implementation of the `git node release --prepare` tooling. PR-URL: #46592 Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
1 parent 25ccaa7 commit d627164

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

doc/contributing/releases.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -341,10 +341,8 @@ The new entry should take the following form:
341341

342342
### Notable changes
343343

344-
* List interesting changes here
345-
* Particularly changes that are responsible for minor or major version bumps
346-
* Also be sure to look at any changes introduced by dependencies such as npm
347-
* ... and include any notable items from there
344+
* List notable changes here
345+
* ...
348346

349347
### Commits
350348

@@ -354,6 +352,12 @@ The new entry should take the following form:
354352
The release type should be either Current, LTS, or Maintenance, depending on the
355353
type of release being produced.
356354

355+
By default, the `### Notable changes` section should be populated with the
356+
commits in the release that have either the `notable-change` or `semver-minor`
357+
label. Some `semver-minor` features may be determined by the releaser, or
358+
indicated by another contributor, to not be appropriate to be listed as a
359+
notable. The ultimate decision rests with the releaser.
360+
357361
You can use `branch-diff` to get a list of commits with the `notable-change`
358362
label:
359363

0 commit comments

Comments
 (0)