Skip to content

Commit 1022c6f

Browse files
doc: add experimental stages
PR-URL: #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>
1 parent 3803d09 commit 1022c6f

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

doc/api/documentation.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,18 @@ The stability indices are as follows:
3232
> [semantic versioning][] rules. Non-backward compatible changes or removal may
3333
> occur in any future release. Use of the feature is not recommended in
3434
> production environments.
35+
>
36+
> Experimental features are subdivided into stages:
37+
>
38+
> * 1.0 - Early development. Experimental features at this stage are unfinished
39+
> and subject to substantial change.
40+
> * 1.1 - Active development. Experimental features at this stage are nearing
41+
> minimum viability.
42+
> * 1.2 - Release candidate. Experimental features at this stage are hopefully
43+
> ready to become stable. No further breaking changes are anticipated but may
44+
> still occur in response to user feedback. We encourage user testing and
45+
> feedback so that we can know that this feature is ready to be marked as
46+
> stable.
3547
3648
<!-- separator -->
3749

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

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

0 commit comments

Comments
 (0)