From 4561e2c9845549e8121d73a7b0501c3b639ccdc1 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sat, 15 Dec 2018 17:52:47 -0800 Subject: [PATCH] doc: revise "Breaking Changes" section of Collaborator Guide Simplify material about TSC approval for breaking changes. Omit extraneous material explaining that purely additive changes are not breaking changes. PR-URL: https://github.com/nodejs/node/pull/25071 Reviewed-By: Anna Henningsen Reviewed-By: Anto Aravinth Reviewed-By: Richard Lau Reviewed-By: Colin Ihrig Reviewed-By: Luigi Pinca Reviewed-By: Yuta Hiroto Reviewed-By: James M Snell --- COLLABORATOR_GUIDE.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 193591381a108a..2d45f25c6ab219 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -242,8 +242,8 @@ For undocumented APIs that are public, open a pull request documenting the API. ### Breaking Changes -Backwards-incompatible changes may land on the master branch at any time after -sufficient review by Collaborators and approval of at least two TSC members. +At least two TSC members must approve backward-incompatible changes to the +master branch. Examples of breaking changes include: @@ -254,11 +254,6 @@ Examples of breaking changes include: * altering expected timing of an event * changing the side effects of using a particular API -Purely additive changes (e.g. adding new events to `EventEmitter` -implementations, adding new arguments to a method in a way that allows -existing code to continue working without modification, or adding new -properties to an options argument) are semver-minor changes. - #### Breaking Changes and Deprecations With a few exceptions outlined below, when backward-incompatible changes to a