Skip to content

doc: add experimental stages #46100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nodejs-github-bot merged 3 commits into from
Jan 14, 2023
Merged

doc: add experimental stages #46100

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
51f1aa0
doc: add experimental stages
GeoffreyBooth Jan 5, 2023
bb4e9c5
Revisions per notes
GeoffreyBooth Jan 6, 2023
6b9f4dc
Revisions from feedback
GeoffreyBooth Jan 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
doc: add experimental stages
  • Loading branch information
@GeoffreyBooth
GeoffreyBooth committed Jan 6, 2023
commit 51f1aa04ba12ae280ced64db89440541b2ede1d8
17 changes: 14 additions & 3 deletions doc/api/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,17 @@ The stability indices are as follows:
> [semantic versioning][] rules. Non-backward compatible changes or removal may
> occur in any future release. Use of the feature is not recommended in
> production environments.
>
> Experimental features are subdivided into stages:
>
> * 1.0 - Early development. Experimental features at this stage are unfinished
Comment thread
GeoffreyBooth marked this conversation as resolved.
> and subject to substantial change. They are not yet ready for user testing.
Comment thread
GeoffreyBooth marked this conversation as resolved.
Outdated
> * 1.1 - Active development. Experimental features at this stage are nearing
Comment thread
GeoffreyBooth marked this conversation as resolved.
Comment thread
GeoffreyBooth marked this conversation as resolved.
> potential stability, with only minor changes expected.
Comment thread
GeoffreyBooth marked this conversation as resolved.
Outdated
> * 1.2 - Release candidate. Experimental features at this stage are hopefully
Comment thread
GeoffreyBooth marked this conversation as resolved.
> ready to become stable. No further breaking changes are anticipated and we
> welcome user testing and feedback so that we can know that this feature is
Comment thread
GeoffreyBooth marked this conversation as resolved.
Outdated
Comment thread
GeoffreyBooth marked this conversation as resolved.
Outdated
> ready to be marked as stable.

<!-- separator -->

Expand All @@ -48,9 +59,9 @@ Features are marked as legacy rather than being deprecated if their use does no
harm, and they are widely relied upon within the npm ecosystem. Bugs found in
legacy features are unlikely to be fixed.

Use caution when making use of Experimental features, particularly within
modules. Users may not be aware that experimental features are being used.
Bugs or behavior changes may surprise users when Experimental API
Use caution when making use of Experimental features, particularly when
authoring libraries. Users may not be aware that experimental features are being
used. Bugs or behavior changes may surprise users when Experimental API
modifications occur. To avoid surprises, use of an Experimental feature may need
a command-line flag. Experimental features may also emit a [warning][].

Expand Down