Skip to content

docs: add experimental flags and migration strategies to the contributing docs #7517

@janechu

Description

@janechu

🙋 Documentation Request

The CONTRIBUTOR.md file should include directions on how to include an experimental feature/change which has potential to make it into a stable release as a replacement or a new feature.

💁 Possible Solution

When a new feature/replacement is proposed we should document:

  • Including it on a separate export path (if possible)
  • Use the @experiemental tag in the comment block
  • Include a comprehensive description
  • Add a link to an issue such as an @see on details about the feature/change (check TSDocs) for details
    • The issue should live in vNext milestone if it is slated for the next major release
  • Understanding that the process means that all @experimental tags will be evaluated during the planning of major releases
  • No @experimental addition should be created without there being an existing GitHub issue

Metadata

Metadata

Assignees

Labels

choreMaintenance or non-code workstatus:plannedWork is planned

Type

Projects

Status

Triage

Relationships

None yet

Development

No branches or pull requests

Issue actions