doc: experimental flag for global accessible APIs #54330
Merged
+17
−0
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
benjamingr
reviewed
Aug 12, 2024
legendecas
force-pushed
the
doc/global-experimental
branch
2 times, most recently
from
50dca30
to
b83e9b3
Compare
jasnell
approved these changes
Aug 27, 2024
|
Updated per nodejs/TSC#1608. |
|
@nodejs/tsc please take a look, thanks :) |
aduh95
approved these changes
Sep 2, 2024
There was a problem hiding this comment.
It might be good to add an explainer on why adding a global is considered semver-major (IIRC it's in case user code is using if(typeof newGlobalVar === 'undefined') /* Node.js specific code here */). IMO we should also better define what we mean by "the global scope", because I think you mean more than just the global object, but anything that's available without an import/require, right?
mcollina
reviewed
Sep 2, 2024
legendecas
force-pushed
the
doc/global-experimental
branch
from
b83e9b3
to
deb442d
Compare
Explicitly document that adding an API to the global scope requires `semver-major` label. Waiving the `semver-major` requires a regular TSC consensus process.
legendecas
force-pushed
the
doc/global-experimental
branch
from
deb442d
to
03b7ace
Compare
|
Thanks for suggestion, updated! |
legendecas
added
the
tsc-agenda
|
Adding
tsc-agenda
|
legendecas
removed
the
tsc-agenda
legendecas
added
the
commit-queue
nodejs-github-bot
removed
the
commit-queue
|
Landed in 23f8ed0 |
aduh95
pushed a commit
that referenced
this pull request
Sep 12, 2024
Explicitly document that adding an API to the global scope requires `semver-major` label. Waiving the `semver-major` requires a regular TSC consensus process. PR-URL: #54330 Refs: #54329 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Michael Dawson <[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.
Explicitly document that adding an API to the global scope requires
semver-majorlabel. Waiving thesemver-majorrequires a regularTSC consensus process.
Refs: #54329