From d627164819564d51fded896bd76ea551539db04b Mon Sep 17 00:00:00 2001 From: Bethany Nicolle Griggs Date: Tue, 21 Feb 2023 20:15:37 +0000 Subject: [PATCH] doc: clarify semver-minor notable changes approach MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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: https://github.com/nodejs/node/pull/46592 Reviewed-By: Richard Lau Reviewed-By: Rafael Gonzaga Reviewed-By: James M Snell Reviewed-By: Michaël Zasso Reviewed-By: Matteo Collina Reviewed-By: Luigi Pinca Reviewed-By: Michael Dawson Reviewed-By: Rich Trott --- doc/contributing/releases.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/doc/contributing/releases.md b/doc/contributing/releases.md index 623c096042ecb6..e7fb0f5d0d8b22 100644 --- a/doc/contributing/releases.md +++ b/doc/contributing/releases.md @@ -341,10 +341,8 @@ The new entry should take the following form: ### Notable changes -* List interesting changes here -* Particularly changes that are responsible for minor or major version bumps -* Also be sure to look at any changes introduced by dependencies such as npm -* ... and include any notable items from there +* List notable changes here +* ... ### Commits @@ -354,6 +352,12 @@ The new entry should take the following form: The release type should be either Current, LTS, or Maintenance, depending on the type of release being produced. +By default, the `### Notable changes` section should be populated with the +commits in the release that have either the `notable-change` or `semver-minor` +label. Some `semver-minor` features may be determined by the releaser, or +indicated by another contributor, to not be appropriate to be listed as a +notable. The ultimate decision rests with the releaser. + You can use `branch-diff` to get a list of commits with the `notable-change` label: