Skip to content

Commit

Permalink
doc: experimental flag for global accessible APIs
Browse files Browse the repository at this point in the history
Explicitly document that adding an API to the global scope requires
`semver-major` label. Waiving the `semver-major` requires a regular
TSC consensus process.
  • Loading branch information
legendecas committed Aug 27, 2024
1 parent 431ac16 commit b83e9b3
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions doc/contributing/collaborator-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -437,6 +437,16 @@ For pull requests introducing new core modules:
* Land with a [Stability Index][] of Experimental. The module must remain
Experimental until a semver-major release.

### Introducing new APIs on the global scope

Exposing APIs to the global scope unconditionally without any CLI flags must
always be labeled as `semver-major`. The `semver-major` label may be waived
through the regular TSC consensus process.

It is recommended to start with exposing APIs to the global scope with an
experimental flag, without being labeled as `semver-major`. When the API is a
release candidate, turn the flag on by default with a CLI flag to opt-out.

### Additions to Node-API

Node-API provides an ABI-stable API guaranteed for future Node.js versions.
Expand Down

0 comments on commit b83e9b3

Please sign in to comment.