Skip to content

Add notes about pre-stabilization to contributor unstable docs #10675

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 18, 2022
Merged

Add notes about pre-stabilization to contributor unstable docs #10675

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions src/doc/contrib/src/process/unstable.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,32 @@ issues are filed, they can be easily tied together.
[tracking issue]: https://github.com/rust-lang/cargo/labels/C-tracking-issue
[tracking issue template]: https://github.com/rust-lang/cargo/issues/new?labels=C-tracking-issue&template=tracking_issue.md

## Pre-Stabilization

Once an unstable feature is "complete", the search for users to test
and give feedback begins. Testing notes should be written up to give users an
idea of how to test the new feature. An example being the
[workspace inheritance testing notes] for workspace inheritance. Once testing
notes have been written up you should make posts in various rust communities
([rust subreddit], [users], [internals], etc). Example posts made for workspace
inheritance: [reddit post], [users post], [internals post]. The unstable feature
should also be added to [This Week in Rust]. This should be done by adding the
label `call-for-testing` to the RFC for the feature and making a comment with a
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this label a thing now? Someone already created it in rust-lang/rfcs, but the discussion of its mechanism seems not yet finished as far as I see.

Apart from that, the write-up looks good to me :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From what I can gather (and have commented on) it is fairly set in stone that the call-for-testing label will be used to denote what should be added to the Call for Testing section. How exactly that label gets added or removed or for how long it will be in TWiR is up in the air. I think that this is a "until we find a better solution" change, which that solution may take a bit of time. I am okay with this being open until everything gets finalized but I think having something is better than nothing. That something could be everything except the stuff for TWiR while it gets completely settled, but I don't know if that is needed.

That being said, I could ask if they would also check rust-lang/cargo for the call-for-testing label if someone can create it here.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair enough. Thanks for the clarification! I am going to merge this, and we can always tweak it afterwards.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The issue that was tracking how call-for-testing should work, got closed so it's a bit more set in stone. I'll keep and eye on any future updates of it and update the docs as needed. Thanks for merging this!

link to the testing notes and the tracking issue (as needed). If there is not an
RFC, a pull request should be made to the [TWiR repo] adding the feature to the
`Call for Testing` section ([example]).

[workspace inheritance testing notes]: https://github.com/rust-lang/cargo/blob/6d6dd9d9be9c91390da620adf43581619c2fa90e/src/doc/src/reference/unstable.md#testing-notes
[rust subreddit]: https://www.reddit.com/r/rust/
[users]: https://users.rust-lang.org/
[internals]: https://internals.rust-lang.org/
[reddit post]: https://www.reddit.com/r/rust/comments/uo8zeh/help_test_workspace_inheritance_in_preparation/
[users post]: https://users.rust-lang.org/t/help-test-workspace-inheritance-in-preparation-for-stablization/75582
[internals post]: https://internals.rust-lang.org/t/help-test-workspace-inheritance-in-preparation-for-stablization/16618
[This Week in Rust]: https://this-week-in-rust.org/
[TWiR repo]: https://github.com/rust-lang/this-week-in-rust
[example]: https://github.com/rust-lang/this-week-in-rust/pull/3256

## Stabilization

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