Skip to content

doc: add experimental stages

Rodrigo Muino Tomonari requested to merge github/fork/GeoffreyBooth/experimental-stages into main

Implements the first PR per https://github.com/nodejs/node/discussions/45900#discussioncomment-4593878. This only defines the stages; follow-up PRs will classify all currently experimental features accordingly and add any stage requirements such as flags or warnings that we decide are appropriate. We could potentially land this PR at the same time as the one that updates the statuses for all experimental features, but I don’t want to start work on that one without reaching consensus on this one first.

Even just on its own, this PR solves a few problems:

  • It encourages more use and testing of experimental features that we’ve been referring to as in the “baking” phase, where we think they’re ready to be marked as stable. This should hopefully catch more bugs before features become stable.

  • It clarifies the refactoring risk that various experimental features have; “release candidate” ones should hopefully require no refactoring due to breaking changes, but “active development” ones very well might; and “early development” ones almost certainly will. Users therefore have a better idea of how much maintenance work they’re signing up for by choosing to use a subject-to-change feature.

Per https://github.com/nodejs/node/discussions/45900#discussioncomment-4593876 I tried to come up with better names for the stages. Please let me know if there are better ideas for names that can reach consensus. 🚲

cc @nodejs/tsc @nodejs/documentation

Merge request reports