Add post about using regression labels #706
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| --- | ||
| layout: post | ||
| title: "Marking issues as regressions" | ||
| description: "Now anyone can mark issues as regressions!" | ||
| author: Camelid | ||
| team: the release team <https://www.rust-lang.org/governance/teams/operations#release> | ||
| --- | ||
|
|
||
| If you've contributed to Rust before, you have likely used a command like this | ||
| to [set labels][rustbot-labeling-docs]: | ||
|
|
||
| > **@rustbot** modify labels: A-typesystem C-enhancement | ||
|
|
||
| Setting labels on issues and pull requests helps us keep track of and filter | ||
| issues. There are many kinds of labels you can set to mark an issue | ||
| as pertinent to a particular team, related to a part of the compiler, or | ||
| what kind of bug it is (a hang, a crash, etc.). | ||
|
|
||
| We also have labels that help us keep track of regressions so that we can | ||
| prioritize them and fix them quickly if they are severe. We have three | ||
| regression labels, each representing when the regression occurred: | ||
|
|
||
| * `regression-from-stable-to-nightly` | ||
| * `regression-from-stable-to-beta` | ||
| * `regression-from-stable-to-stable` | ||
|
|
||
| We recently had a case where a [regression was not caught][internals-thread] | ||
| before a release because the issue was not marked with a regression label. | ||
| So we have now [added the ability][regression-label-pr] for *anyone* to set | ||
| regression labels on issues! This is all you have to do to mark an issue as a | ||
| regression and it will automatically be prioritized: | ||
|
|
||
| > **@rustbot** modify labels: regression-from-stable-to-{release-channel} | ||
|
There was a problem hiding this comment. I think we should include regression-untriaged here as well, and perhaps only that. Regardless we should expand upon this to include that you should test on current stable and beta when reporting regressions so that we can appropriately categorize (i.e., the closest to stable should be chosen). |
||
|
|
||
| Just replace `{release-channel}` with one of `nightly`, `beta`, or `stable`, | ||
| depending on when the regression occurred, and you're good to go! | ||
|
|
||
| Alternatively, if you are reporting a new regression, you can use the regression | ||
| [issue template]. It will guide you through the process of reporting a | ||
| regression and providing information that will help us fix the issue. | ||
|
|
||
| Finally, if you have an issue that is *not* a regression, but is still something | ||
| that is important to be fixed, you can request prioritization with: | ||
|
|
||
| > **@rustbot** prioritize | ||
|
|
||
| We really appreciate it if you mark all regressions with an appropriate label | ||
| so we can track them and fix them as soon as possible! | ||
|
|
||
| [rustbot-labeling-docs]: https://rustc-dev-guide.rust-lang.org/rustbot.html#issue-relabeling | ||
| [internals-thread]: https://internals.rust-lang.org/t/1-46-is-unusable-for-me-solved/13161/10 | ||
| [regression-label-pr]: https://github.com/rust-lang/rust/pull/77555 | ||
| [issue template]: https://github.com/rust-lang/rust/issues/new/choose | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should avoid starting off like this. People who haven't used it might feel excluded. Plus, I think this post should actually be moved to the main blog: inside rust is targeted to contributors, but we want regular users to do this as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's a good point, I didn't think of that. Perhaps I'll go with something like "One of the ways we keep track of Rust issues is with labels, which you can modify using a command like this...". Or maybe it would make more sense to just skip this part?
Sounds good, I was thinking of suggesting that.