Skip to content

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

New issue

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

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

Already on GitHub? # to your account

Merged
merged 1 commit into from
May 18, 2022

Conversation

Muscraft
Copy link
Member

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 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 section to TWiR. This comment gives more information as well.

As for the requirement of testing notes, there is still discussion about if they are needed.

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

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 17, 2022
Copy link
Member

@weihanglo weihanglo left a comment

Choose a reason for hiding this comment

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

Nitpick: Could we use link references instead of inline links for source code readability?

@Muscraft
Copy link
Member Author

Yep! I'll make that change!

@Muscraft Muscraft force-pushed the update-contrib-docs branch from 02cfe9d to 5418d58 Compare May 17, 2022 17:44
@Muscraft
Copy link
Member Author

It looks like this failed for network connectivity issues. Can someone rerun this for me?

([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!

@weihanglo
Copy link
Member

@bors r+

@bors
Copy link
Contributor

bors commented May 18, 2022

📌 Commit 5418d58 has been approved by weihanglo

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 18, 2022
@bors
Copy link
Contributor

bors commented May 18, 2022

⌛ Testing commit 5418d58 with merge a4c1cd0...

@bors
Copy link
Contributor

bors commented May 18, 2022

☀️ Test successful - checks-actions
Approved by: weihanglo
Pushing a4c1cd0 to master...

@bors bors merged commit a4c1cd0 into rust-lang:master May 18, 2022
JohnTitor added a commit to JohnTitor/rust that referenced this pull request May 18, 2022
Update cargo

3 commits in 3f052d8eed98c6a24f8b332fb2e6e6249d12d8c1..a4c1cd0eb6b18082a7e693f5a665548fe1534be4
2022-05-12 15:19:04 +0000 to 2022-05-18 01:52:07 +0000
- Add notes about pre-stabilization to contributor unstable docs (rust-lang/cargo#10675)
- reference: Update syntax supported by `rustc-link-lib` (rust-lang/cargo#10674)
- Correct the release dates for 1.61 and 1.62 (rust-lang/cargo#10665)
JohnTitor added a commit to JohnTitor/rust that referenced this pull request May 18, 2022
Update cargo

3 commits in 3f052d8eed98c6a24f8b332fb2e6e6249d12d8c1..a4c1cd0eb6b18082a7e693f5a665548fe1534be4
2022-05-12 15:19:04 +0000 to 2022-05-18 01:52:07 +0000
- Add notes about pre-stabilization to contributor unstable docs (rust-lang/cargo#10675)
- reference: Update syntax supported by `rustc-link-lib` (rust-lang/cargo#10674)
- Correct the release dates for 1.61 and 1.62 (rust-lang/cargo#10665)
@ehuss ehuss added this to the 1.63.0 milestone May 20, 2022
@Muscraft Muscraft deleted the update-contrib-docs branch May 27, 2022 01:15
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants