Skip to content

Commit 7da5caa

Browse files
committed
docs(contrib): Make it easier to scan Call for Testing instructions
1 parent 0cda0f1 commit 7da5caa

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

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

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -62,17 +62,16 @@ something is only partially implemented, it may have both
6262
## Pre-Stabilization
6363

6464
Once an unstable feature is "complete", the search for users to test
65-
and give feedback begins. Testing notes should be written up to give users an
66-
idea of how to test the new feature. An example being the
67-
[workspace inheritance testing notes] for workspace inheritance. Once testing
68-
notes have been written up you should make posts in various rust communities
69-
([rust subreddit], [users], [internals], etc). Example posts made for workspace
70-
inheritance: [reddit post], [users post], [internals post]. The unstable feature
71-
should also be added to [This Week in Rust]. This should be done by adding the
72-
label `call-for-testing` to the RFC for the feature and making a comment with a
73-
link to the testing notes and the tracking issue (as needed). If there is not an
74-
RFC, a pull request should be made to the [TWiR repo] adding the feature to the
75-
`Call for Testing` section ([example]).
65+
and give feedback begins:
66+
1. Write up test instructions for users, summarizing where the feature is useful, how to use it (with links to the unstable documentation), and if there are any areas of particular concern
67+
- This could be on the tracking issue or in a dedicated issue for feedback
68+
- e.g. [workspace inheritance testing notes]
69+
2. Call for testing
70+
- In the RFC, link to the test instructions and label it with with `call-for-testing` to be picked up by [This Week in Rust]
71+
- If there is not an RFC, a pull request should be made to the [TWiR repo]
72+
adding the feature to the `Call for Testing` section ([example]).
73+
- Post on various Rust communities ([rust subreddit], [users], [internals], etc)
74+
- e.g. [reddit post], [users post], [internals post]
7675

7776
[workspace inheritance testing notes]: https://github.com/rust-lang/cargo/blob/6d6dd9d9be9c91390da620adf43581619c2fa90e/src/doc/src/reference/unstable.md#testing-notes
7877
[rust subreddit]: https://www.reddit.com/r/rust/

0 commit comments

Comments
 (0)