OSSForks/node
1
0
Fork 0
mirror of https://github.com/zebrajr/node.git synced 2026-01-15 12:15:26 +00:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

doc: add experimental stages

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/46100
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
This commit is contained in:
Geoffrey Booth
2023-01-14 06:25:08 -08:00
committed by GitHub
parent 3803d09308
commit 1022c6f424
1 changed files with 15 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
doc/api/documentation.md
View File

@@ -32,6 +32,18 @@ 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
> and subject to substantial change.
> * 1.1 - Active development. Experimental features at this stage are nearing
> minimum viability.
> * 1.2 - Release candidate. Experimental features at this stage are hopefully
> ready to become stable. No further breaking changes are anticipated but may
> still occur in response to user feedback. We encourage user testing and
> feedback so that we can know that this feature is ready to be marked as
> stable.
<!-- separator -->
@@ -48,9 +60,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][].