doc: revise deprecation semverness info in Collaborator Guide #26232
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
Co-Authored-By: Trott <[email protected]>
BridgeAR
approved these changes
Feb 21, 2019
| changes. Such deprecations have no impact on the successful operation of running | ||
| code and therefore should not be viewed as breaking changes. | ||
| Apply the `notable change` label to all pull requests that introduce | ||
| Documentation-Only Deprecations. Such deprecations have no impact on code |
There was a problem hiding this comment.
AFAIK we try to add the label to all deprecations - no matter if it's doc-only, runtime or end-of-life.
There was a problem hiding this comment.
Yes, and that's noted on line 371 currently. I'm repeating it here though because Documentation-Only deprecations are the ones most likely to be missed as notable changes. Other ones go in as semver-major so they're likely to be noticed.
Trott
added
the
author ready
Trott
added a commit
to Trott/io.js
that referenced
this pull request
Feb 28, 2019
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: nodejs#26232 Reviewed-By: Ruben Bridgewater <[email protected]>
|
Landed in 04d5c1b |
addaleax
pushed a commit
that referenced
this pull request
Mar 1, 2019
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]>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 changelabels etc. instead of suggesting thatdoc-deprecations be treated as
semver-minor. The idea that adeprecation 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 changeetc.Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes