Skip to content

Commit a6b160a

Browse files
committed
Address feedback
1 parent 3d1ae6e commit a6b160a

File tree

1 file changed

+23
-8
lines changed

1 file changed

+23
-8
lines changed

src/release/issue-triaging.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The `rust-lang/rust` repository has thousands of issues and hundreds of people w
1010
It is impossible for all people to check and solve issues. The goals of triaging are connecting
1111
issues to the relevant people, and helping them be more effective at fixing the issue.
1212

13-
In practice, it is unrealistic for all issues to be solved quickly and found the by right people.
13+
In practice, it is unrealistic for all issues to be solved quickly and found by right people.
1414
Through applications of labels we make the issue tracker more searchable for future reference,
1515
so that people in the future have an easier time finding related issues or issues they are interested
1616
in working on.
@@ -21,27 +21,31 @@ as triaging work is highly parallelizable and easy to get started with.
2121
## Initial triaging
2222

2323
When an issue is opened, it gets the `needs-triage` label. This ensures that every issue gets an initial
24-
look and that no issue is forgotten, or that when it is forgotten, it is at least visibly forgotten by still having the label.
24+
look and that no issue is ignored, or that when it is ignored, it is at least visibly ignored by still having the label.
2525

2626
`needs-triage` is an initial checkpoint. The effort needed to get an issue past the label should be minimal.
2727

2828
To do the initial triage and remove the `needs-triage` label, the following conditions should be fulfilled/considered.
29-
It's okay if not all of these are always considered, treat it as guideline, not a hard check list. It is also not exhaustive.
29+
It's okay if not all of these are always considered; treat it as a guideline, not a hard checklist. It is also not exhaustive.
3030

31-
- The issue should make sense, that is it should present a problem.
32-
- For example, if an issue is a question about Rust in general, the issue should be closed and the user redicted to URLO/Discord.
31+
- The issue should make sense, that is, it should present a problem.
32+
- For example, if an issue is a question about Rust in general, the issue should be closed and the user redirected to URLO/Discord.
3333
You can of course answer the question too :) (but make sure to mention that the user should go to URLO/Discord next time).
3434
- Add appropriate labels ([Labels](#labels))
3535
- Specifically, `T-*` and `C-*` are the most relevant
3636
- If the issue contains no reproduction but needs one, ask for one and add the `S-needs-repro` label
37+
- The issue is the wrong place for some kinds of feature requests. Tell the author about it.
38+
- Library API requests should follow [its processes](https://std-dev-guide.rust-lang.org/development/feature-lifecycle.html).
39+
- Language changes should be redirected to [IRLO](https://internals.rust-lang.org/) or Zulip (t-lang).
3740
- If the issue could benefit from bisecting the regression, add `E-needs-bisection` (or do the bisection yourself)
3841
- Does this issue require nightly? Add `requires-nightly`.
3942
- Is the issue a regression? Apply the `regression-untriaged` label (or figure out what regression it is exactly)
4043
- If you happen to know people who this issue is relevant to, ping them.
4144
- For example, write `cc @ThatPerson` if `ThatPerson` has been working a lot on the problematic feature recently
4245
- Does this issue require incomplete or internal features? Add `requires-{incomplete,internal}-features`.
4346

44-
For applying and removing labels, unprivileged users can use rustbot.
47+
For applying and removing labels, unprivileged users can use **@rustbot** to add or remove
48+
[the labels allowed by the `triagebot.toml` configuration](https://github.com/rust-lang/rust/blob/master/triagebot.toml).
4549
For example, `@rustbot label +T-compiler +C-bug +A-linkage +O-macos -needs-triage`.
4650

4751
To see a list of all labels, check out the "labels" page next to the search bar in the issue tracker.
@@ -59,13 +63,19 @@ Another useful thing to do is go through `E-needs-mcve` and `E-needs-bisection`
5963
(using [cargo-bisect-rustc](`https://github.com/rust-lang/cargo-bisect-rustc`)). When you provide one, you can also remove the label
6064
using rustbot (`@rustbot label -E-needs-bisection`).
6165

66+
At the time of writing, there is also the `needs-triage-legacy` label, for older issues that are suspected to not have been triaged.
67+
Triaging them the same way as `needs-triage` is also useful.
68+
6269
## Labels
6370

6471
There are many different labels that can be applied to issues.
6572

6673
- `needs-triage`: signals that an issue is new and needs initial triage
6774
- `T-*`: Specifies the team or teams that this issue is relevant to, for example compiler, types or libs
75+
- `WG-*`: Specifies the working groups that this issue is relevant to, for example WG-debugging.
6876
- `C-*`: Specifies the category of the label, for example a bug, tracking issue or discussion
77+
- `A-diagnostics` issues usually don't have any C label.
78+
- Also note `C-optimization` for missed compiler optimizations.
6979
- `O-*`: For platform-specific issues, specifies the platform (architecture or operating system). For example macos, aarch64, windows
7080
- `A-*`: The areas that the issue is relevant to, for example linkage, patterns, diagnostics
7181
- `F-*`: When the issue concerns a specific (usually unstable) feature
@@ -74,7 +84,12 @@ There are many different labels that can be applied to issues.
7484
should be closed in accordance with compiler [MCP 620](https://github.com/rust-lang/compiler-team/issues/620).
7585
- `regression-*`: Labels for tracking issues that are regressions.
7686
- `D-*`: Labels for diagnostics issue.
77-
- `I-*`: Different labels about the nature (originally, importance) of a bug. For example ICE, slow code, heavy code, crashes, unsoundness.
87+
- `I-*`: Different labels about the nature (originally, importance) of a bug. For example ICE, slow code, heavy code (binary size), crashes, unsoundness.
88+
There are also some other `I-*` labels that don't really fit into this. For triaging, focus on `I-slow`, `I-heavy`, `I-ICE`, `I-crash`, `I-unsound`.
7889
- `P-*`: Priority labels. Applied using the [Compiler Prioritization procedure](../compiler/prioritization.md)
7990
- `S-*`: The status of an issue, for example S-needs-repro.
80-
- `E-*`: Calls for participation, for example to minimize an issue (E-needs-mcve) or because there is mentoring available (E-mentor).
91+
- `E-*`: Calls for participation, for example to minimize an issue
92+
- `E-mentor`: A mentor is available to help with the issue, which makes for good first issues.
93+
- `E-needs-mcve`: This issue has a reproduction, but it is not minimal, it should be minimized.
94+
- `E-needs-test`: The issue has been fixed, but no test has been added for it. After someone adds a test, it can be closed.
95+
- `E-{easy,medium,hard}`: Someone has estimated how hard the issue is to fix. This can help with finding good first issues, but is [bound to be inaccurate](https://en.wikipedia.org/wiki/Curse_of_knowledge).

0 commit comments

Comments
 (0)