Skip to content

Commit 1f34895

Browse files
committed
feat: update experiments workflow to reflect use of issue field instead of labels
1 parent b4710d2 commit 1f34895

1 file changed

Lines changed: 16 additions & 16 deletions

File tree

website/src/docs/experiments/index.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -93,19 +93,19 @@ Task.
9393
All experimental features start with a proposal in the form of a GitHub issue.
9494
If the maintainers decide that an issue has enough support and is a breaking
9595
change or is complex/controversial enough to require user feedback, then the
96-
issue will be marked with the `status: proposal` label. At this point, the issue
97-
becomes a proposal and a period of consultation begins. During this period, we
98-
request that users provide feedback on the proposal and how it might effect
99-
their use of Task. It is up to the discretion of the maintainers to decide how
100-
long this period lasts.
96+
issue's experiment status field will be set to `proposed`. At this point, the
97+
issue becomes a proposal and a period of consultation begins. During this
98+
period, we request that users provide feedback on the proposal and how it might
99+
effect their use of Task. It is up to the discretion of the maintainers to
100+
decide how long this period lasts.
101101

102102
### 2. Draft
103103

104104
Once a proposal's consultation ends, a contributor may pick up the work and
105105
begin the initial implementation. Once a PR is opened, the maintainers will
106106
ensure that it meets the requirements for an experimental feature (i.e. flags
107107
are in the right format etc) and merge the feature. Once this code is released,
108-
the status will be updated via the `status: draft` label. This indicates that an
108+
the experiment status field will be updated to `draft`. This indicates that an
109109
implementation is now available for use in a release and the experiment is open
110110
for feedback.
111111

@@ -120,14 +120,14 @@ experimental features may be abandoned _at any time_.
120120
### 3. Candidate
121121

122122
Once an acceptable level of consensus has been reached by the community and
123-
feedback/changes are less frequent/significant, the status may be updated via
124-
the `status: candidate` label. This indicates that a proposal is _likely_ to
123+
feedback/changes are less frequent/significant, the experiment status field will
124+
be updated to `candidate`. This indicates that a proposal is _likely_ to
125125
accepted and will enter a period for final comments and minor changes.
126126

127127
### 4. Stable
128128

129-
Once a suitable amount of time has passed with no changes or feedback, an
130-
experiment will be given the `status: stable` label. At this point, the
129+
Once a suitable amount of time has passed with no changes or feedback, the
130+
experiment status field will be updated to `stable`. At this point, the
131131
functionality will be treated like any other feature in Task and any changes
132132
_must_ be backward compatible. This allows users to migrate to the new
133133
functionality without having to worry about anything breaking in future
@@ -136,13 +136,13 @@ version.
136136

137137
### 5. Released
138138

139-
When making a new major release of Task, all experiments marked as
140-
`status: stable` will move to `status: released` and their behaviors will become
141-
the new default in Task. Experiments in an earlier stage (i.e. not stable)
142-
cannot be released and so will continue to be experiments in the new version.
139+
When an experiment moves to a `released` status, it becomes the default behavior
140+
and flags or config are no longer required to enable the feature. For
141+
non-breaking changes, this will happen in a minor release. For breaking changes,
142+
this will happen in a major release.
143143

144144
### Abandoned / Superseded
145145

146-
If an experiment is unsuccessful at any point then it will be given the
147-
`status: abandoned` or `status: superseded` labels depending on which is more
146+
If an experiment is unsuccessful at any point then the experiment status field
147+
will be updated to `abandoned` or `superseded` depending on which is more
148148
suitable. These experiments will be removed from Task.

0 commit comments

Comments
 (0)