Skip to content

Commit 8584068

Browse files
Trottaddaleax
authored andcommitted
doc: revise deprecation semverness info in Collaborator Guide
Simplify and clarify deprecation semverness information in the Collaborator Guide. Unlike some of the other changes I've made lately, this one is not merely cosmetic. It changes information about how to handle deprecations vis-a-vis SemVer. The revised conventions take advange of `notable change` labels etc. instead of suggesting that doc-deprecations be treated as `semver-minor`. The idea that a deprecation is a new feature seems incorrect from a SemVer perspective, but probably made sense at the time the text was written if we weren't yet using `notable change` etc. PR-URL: #26232 Reviewed-By: Ruben Bridgewater <[email protected]>
1 parent d8f5f55 commit 8584068

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

COLLABORATOR_GUIDE.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -339,13 +339,13 @@ documentation must state the deprecation status.
339339
* Backward-incompatible changes including complete removal of such APIs may
340340
occur at any time.
341341

342-
Documentation-Only Deprecations may be handled as semver-minor or semver-major
343-
changes. Such deprecations have no impact on the successful operation of running
344-
code and therefore should not be viewed as breaking changes.
342+
Apply the `notable change` label to all pull requests that introduce
343+
Documentation-Only Deprecations. Such deprecations have no impact on code
344+
execution. Thus, they are not breaking changes (`semver-major`).
345345

346-
Runtime Deprecations and End-of-life APIs (internal or public) must be
347-
handled as semver-major changes unless there is TSC consensus to land the
348-
deprecation as a semver-minor.
346+
Runtime Deprecations and End-of-life APIs (internal or public) are breaking
347+
changes (`semver-major`). The TSC may make exceptions, deciding that one of
348+
these deprecations is not a breaking change.
349349

350350
All Documentation-Only and Runtime deprecations will be assigned a unique
351351
identifier that can be used to persistently refer to the deprecation in

0 commit comments

Comments
 (0)