Skip to content

Commit 1ff8054

Browse files
author
Carolyn Zech
authored
Fix stabilization instructions in RFC intro (#4067)
The introduction to our RFC book instructs people to remove the unstable flag in one go when they're stabilizing features, which contradicts the instructions from the unstable APIs RFC to do a two-phase deletion. Update the intro to be consistent with the two-phase deletion approach. By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.
1 parent 1e9e8db commit 1ff8054

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

rfc/src/intro.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,10 @@ This is the overall workflow for the RFC process:
6161
4. Add regression tests to cover all expected behaviors and unit tests whenever possible.
6262
5. Stabilization.
6363
1. Propose to stabilize the feature when feature is well tested and UX has received positive feedback.
64-
2. Create a new PR that removes the `-Z <FEATURE_ID>` guard and that marks the RFC status as "STABLE".
64+
2. Create a new PR that makes the option a no-op with a deprecation warning.
65+
3. *Only after the PR from #2 is included in a release*, create another PR that actually removes the option and marks the RFC status as "STABLE".
6566
1. Make sure the RFC reflects the final implementation and user experience.
67+
2. See [#3561](https://github.com/model-checking/kani/issues/3561) for an example of such a two-phase deletion, where we first deprecate the option in one release, then remove it in the next. See also [0006-unstable-api](rfcs/0006-unstable-api.md).
6668
3. In some cases, we might decide not to incorporate a feature
6769
(E.g.: performance degradation, bad user experience, better alternative).
6870
In those cases, please update the RFC status to "CANCELLED as per <PR_LINK | ISSUE_LINK>" and remove the code

0 commit comments

Comments
 (0)