Skip to content

Commit a4c1cd0

Browse files
committed
Auto merge of #10675 - Muscraft:update-contrib-docs, r=weihanglo
Add notes about pre-stabilization to contributor unstable docs This PR is meant to add more direction for contributors on the path to stabilization for unstable features. It adds a section titled `Pre-Stabilization` to the unstable contributor docs. The idea for this [came out of the discussion](https://rust-lang.zulipchat.com/#narrow/stream/246057-t-cargo/topic/workspace.20inheritance.20stabilization/near/281856280) about when and how to stabilize workspace inheritance. The notes that are being added were derived from the above comment as well as the [the adding of the `Call for Testing`](rust-lang/this-week-in-rust#3236) section to TWiR. [This comment](rust-lang/this-week-in-rust#3260 (comment)) gives more information as well. As for the requirement of testing notes, [there is still discussion about if they are needed](rust-lang/this-week-in-rust#3260 (comment)). While what was added is not comprehensive it is meant as a guide for what to do as each feature has different requirements for stabilization r? `@epage`
2 parents d14c59d + 5418d58 commit a4c1cd0

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

src/doc/contrib/src/process/unstable.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,32 @@ issues are filed, they can be easily tied together.
4242
[tracking issue]: https://github.com/rust-lang/cargo/labels/C-tracking-issue
4343
[tracking issue template]: https://github.com/rust-lang/cargo/issues/new?labels=C-tracking-issue&template=tracking_issue.md
4444

45+
## Pre-Stabilization
46+
47+
Once an unstable feature is "complete", the search for users to test
48+
and give feedback begins. Testing notes should be written up to give users an
49+
idea of how to test the new feature. An example being the
50+
[workspace inheritance testing notes] for workspace inheritance. Once testing
51+
notes have been written up you should make posts in various rust communities
52+
([rust subreddit], [users], [internals], etc). Example posts made for workspace
53+
inheritance: [reddit post], [users post], [internals post]. The unstable feature
54+
should also be added to [This Week in Rust]. This should be done by adding the
55+
label `call-for-testing` to the RFC for the feature and making a comment with a
56+
link to the testing notes and the tracking issue (as needed). If there is not an
57+
RFC, a pull request should be made to the [TWiR repo] adding the feature to the
58+
`Call for Testing` section ([example]).
59+
60+
[workspace inheritance testing notes]: https://github.com/rust-lang/cargo/blob/6d6dd9d9be9c91390da620adf43581619c2fa90e/src/doc/src/reference/unstable.md#testing-notes
61+
[rust subreddit]: https://www.reddit.com/r/rust/
62+
[users]: https://users.rust-lang.org/
63+
[internals]: https://internals.rust-lang.org/
64+
[reddit post]: https://www.reddit.com/r/rust/comments/uo8zeh/help_test_workspace_inheritance_in_preparation/
65+
[users post]: https://users.rust-lang.org/t/help-test-workspace-inheritance-in-preparation-for-stablization/75582
66+
[internals post]: https://internals.rust-lang.org/t/help-test-workspace-inheritance-in-preparation-for-stablization/16618
67+
[This Week in Rust]: https://this-week-in-rust.org/
68+
[TWiR repo]: https://github.com/rust-lang/this-week-in-rust
69+
[example]: https://github.com/rust-lang/this-week-in-rust/pull/3256
70+
4571
## Stabilization
4672

4773
After some period of time, typically measured in months, the feature can be

0 commit comments

Comments
 (0)