Describes how to push for stabilization. #125
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The current guide only talks about how to create a PR after we have decided to stabilize a feature. I've now updated this document to show how to start the stabilization process.
mgattozzi
reviewed
Feb 8, 2018
stabilization-guide.md
Outdated
|
|
||
| Prepare PRs to update the documentations involving this new feature. You will likely need to submit PRs to [The Reference], [The Book] and [Rust by Example]. See the [Updating documentation](#updating-documentation) at the end of this page for detailed requirements. | ||
|
|
||
| Maintainers of these repositories will keep these PRs open until the whole stabilization process has completed. Meanwhile, we could proceed to the next step. |
There was a problem hiding this comment.
You might want to say can rather than could because it implies that you shouldn't have to wait around for these PRs to land. If you want the language to be even stronger with this using should is another good choice! :D This also applies to line 37 as well!
mgattozzi
reviewed
Feb 8, 2018
stabilization-guide.md
Outdated
|
|
||
| ### Write a stabilization report | ||
|
|
||
| Find the tracking issue of the feature, and create a short stabilization report. Essentially this would be a brief summary of the feature plus some links to test cases showing it works as expected, along with a list of edge cases that came up and and were considered. This seems like a sort of minimal "due diligence" that we ought to do before stabilizing. |
There was a problem hiding this comment.
seems like a sort of -> is a
ought to -> cut it out of the sentence
We're telling the user they need to write this so we shouldn't use language that might imply they don't need to!
There was a problem hiding this comment.
Thanks, I just copied the whole paragraph from niko's comment 😛
9 tasks
|
This content is being added to the rustc-guide in rust-lang/rustc-dev-guide#262, so we can probably close this PR. |
|
Done. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current guide only talks about how to create a PR after we have decided to stabilize a feature. I've now updated this document to show how to start the stabilization process.