Skip to content

Commit a458756

Browse files
committed
Auto merge of #14052 - epage:triage, r=weihanglo
docs(contrib): Improve triage instructions ### What does this PR try to resolve? `@torhovland` brought up some confusions they had when looking at our triage instructions and this attempts to fix them. ### How should we test and review this PR? ### Additional information
2 parents 1cbcb4f + 390accf commit a458756

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

src/doc/contrib/src/issues.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -155,8 +155,9 @@ different steps, or in rare cases have multiple statuses.
155155
* **[S-needs-rfc]** --- Needs an [RFC] before this can make more progress.
156156

157157
Anyone is welcome to help at this stage, but it should be clear that it is
158-
not yet accepted. However, this should only be tagged for changes that are
159-
somewhat likely to be accepted.
158+
not yet accepted.
159+
See [Before creating an RFC](https://github.com/rust-lang/rfcs?tab=readme-ov-file#before-creating-an-rfc)
160+
for next steps.
160161

161162
* **[S-needs-mentor]** --- Needs a Cargo team member to commit to helping and
162163
reviewing.
@@ -197,10 +198,13 @@ issues have not yet been triaged.
197198
There are several things to consider when triaging an issue:
198199

199200
* Is this a duplicate? Search the issue tracker (including closed issues) to
200-
see if there is something similar or identical to what is reported. If it is
201-
obviously a duplicate, write a comment that it is a duplicate of the other
202-
issue, and close the issue. If it isn't obvious that it is a duplicate,
203-
leave a comment asking the author if the other issue covers what they reported.
201+
see if there is an issue with a similar or identical root cause to what is reported.
202+
We generally focus issues around root causes so alternative solutions can be
203+
discussed and evaluated together.
204+
If it is obviously a duplicate, write a comment that it is a duplicate of the
205+
other issue, and close the issue.
206+
If it isn't obvious that it is a duplicate, leave a comment asking the author
207+
if the other issue covers what they reported.
204208

205209
* For a bug, check if the report contains enough information to reproduce it.
206210
If you can't reproduce it, solicit more information from the author to
@@ -214,20 +218,19 @@ There are several things to consider when triaging an issue:
214218
prefixed labels (depending on if it is a regression in an already
215219
released stable release, or it is in nightly).
216220

217-
* Assuming the issue looks valid, remove the [S-triage] label and move it onto
218-
a new status:
221+
* Assuming the issue looks valid, switch the [S-triage] label for one of the following:
219222

220-
* [S-needs-rfc] --- This is a large feature request that will require a
221-
public design process.
222-
* [S-needs-design] --- The resolution of the issue or small feature request
223-
will need more work to come up with the appropriate design.
224223
* [S-needs-team-input] --- The next steps are not clear, and the Cargo team
225224
needs to discuss whether or not to proceed and what needs to be done to
226225
address the issue.
226+
* [S-needs-design] --- The resolution of the issue or small feature request
227+
will need more work to come up with the appropriate design.
228+
* [S-needs-rfc] --- This is a large feature request that will require a
229+
public design process.
227230
* [S-needs-mentor] --- This is something the Cargo team wants to address,
228-
but does not currently have the capacity to help with reviewing.
231+
but does not currently have the capacity to help with reviewing. **(reserved for Cargo team)**
229232
* [S-accepted] --- This is something that clearly needs to be addressed, and
230-
a Cargo team member has volunteered to help review.
233+
a Cargo team member has volunteered to help review. **(reserved for Cargo team)**
231234

232235
Anyone is welcome to help with the triaging process. You can help with
233236
reproducing issues, checking for duplicates, gathering more information from

0 commit comments

Comments
 (0)