diff options
| author | Geoffrey Booth <webadmin@geoffreybooth.com> | 2023-01-14 06:25:08 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-14 14:25:08 +0000 |
| commit | 1022c6f424533bd58396f9c7bb5b93cde4ec78fc (patch) | |
| tree | 4059b325b7551c3582fcae4a848db1de3b1516b9 /doc/api/documentation.md | |
| parent | 3803d0930809c8400f0f9bdc815e35b207d18ae8 (diff) | |
| download | node-new-1022c6f424533bd58396f9c7bb5b93cde4ec78fc.tar.gz | |
doc: add experimental stages
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>
Diffstat (limited to 'doc/api/documentation.md')
| -rw-r--r-- | doc/api/documentation.md | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/doc/api/documentation.md b/doc/api/documentation.md index 008bdb82f4..6adbdc11ad 100644 --- a/doc/api/documentation.md +++ b/doc/api/documentation.md @@ -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][]. |