Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add issue triage guidelines #463

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add issue triage guidelines #463

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50f552d
Add issue triage guidelines
jonas-schievink Oct 20, 2020
c88b3a7
Close issues instead of transferring them
jonas-schievink Oct 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 39 additions & 5 deletions src/release/triage-procedure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,9 +247,44 @@ future work.

## Issue triage

Issue triage is mostly much simpler. After finishing PR triage, go to the [list
of untagged issues] and add tags as you see fit. The following categories
should, ideally, be assigned to each issue:
### Incorrectly Filed Issues

Frequently, issues are filed against the wrong repository. In that case, you can
use GitHub's "Transfer issue" function to move it to the right place. When you
do that, please also leave a comment explaining why you moved it.

Some issues might not belong on GitHub at all, in which case they may be closed
with an appropriate comment pointing to the right place.

Issues in [`rust-lang/rust`] should be closed in the following cases:

* **Language Feature Requests** that might require non-trivial design effort
should closed in favor of the [RFC process] or a discussion on [IRLO].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we should direct folks to https://lang-team.rust-lang.org/proposing_a_project.html instead

* **Library Feature Requests** that encompass more than just a small addition
to the standard library should likewise be closed in favor of the
[RFC process] or discussion on [IRLO].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like @KodrAus (in rust-lang/rfcs#2979) was suggesting that libs team might adpt a lighterweight process here too...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeh, I think what we've all been working out that would apply to Libs too would see these larger additions run through a staged process that doesn't necessarily require an RFC up-front.

* **Questions** about how to use Rust should be closed and the author directed
to [URLO] or other official venues.
* **Usage Errors**, where the problem turns out to be in the user's code, should
be closed or converted to diagnostic enhancement requests where applicable
(`A-diagnostics` + `C-enhancement`).

What exactly constitutes a "non-trivial" or "large" feature request is left up
to the personal judgement of the triager.

If you regularly triage incoming issues, it might make sense to make use of
GitHub's "saved replies" feature to predefine canned replies for common cases.

[`rust-lang/rust`]: https://github.com/rust-lang/rust
[RFC process]: https://github.com/rust-lang/rfcs
[IRLO]: https://internals.rust-lang.org/
[URLO]: https://users.rust-lang.org/

### Labeling Issues

Labels should be added to all newly opened issues, as well as older
[untagged issues]. The following categories should, ideally, be assigned to each
issue:

- At least one `A-` tag. This represents the area of the issue, so an issue
relating to benchmarks or testing would get A-libtest. If you can't find an
Expand Down Expand Up @@ -296,7 +331,7 @@ if they require assistance, and inform them that after 14 days this issue will
be made available to anyone. After 14 days re-add the help tag and deassign them
if necessary.

[list of untagged issues]: https://github.com/rust-lang/rust/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20sort%3Acreated-asc%20-label%3AC-feature-request%20-label%3AC-enhancement%20-label%3AC-cleanup%20-label%3AC-bug%20-label%3AC-tracking-issue%20-label%3AC-future-compatibility%20-label%3AC-question%20-label%3AC-feature-accepted
[untagged issues]: https://github.com/rust-lang/rust/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20sort%3Acreated-asc%20-label%3AC-feature-request%20-label%3AC-enhancement%20-label%3AC-cleanup%20-label%3AC-bug%20-label%3AC-tracking-issue%20-label%3AC-future-compatibility%20-label%3AC-question%20-label%3AC-feature-accepted

## State Of Rust Triage

Expand Down Expand Up @@ -331,4 +366,3 @@ if necessary.

[state of rust]: https://github.com/rust-lang/rust/projects/8
[#release Discord channel]: https://discord.gg/rust-lang