Skip to content

Commit 826e514

Browse files
authored
Issues priority (#15393)
We can actualize "Issue and PR triage" section. Seems labels [P-medium](https://github.com/rust-lang/rust-clippy/labels/P-medium), [P-high](https://github.com/rust-lang/rust-clippy/labels/P-high), [L-sync-blocker](https://github.com/rust-lang/rust-clippy/labels/L-sync-blocker) are not relevant anymore. Suppose that we can save the priority from [feature freeze](https://github.com/alex-semenyuk/rust-clippy/blob/master/book/src/development/feature_freeze.md?plain=1) since the only difference accepting new lints. changelog: none
2 parents d6cf7b9 + 68ef9c4 commit 826e514

File tree

1 file changed

+26
-18
lines changed

1 file changed

+26
-18
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -199,26 +199,34 @@ currently. Between writing new lints, fixing issues, reviewing pull requests and
199199
responding to issues there may not always be enough time to stay on top of it
200200
all.
201201

202-
Our highest priority is fixing [ICEs][I-ICE] and [bugs][C-bug], for example
203-
an ICE in a popular crate that many other crates depend on. We don't
204-
want Clippy to crash on your code and we want it to be as reliable as the
205-
suggestions from Rust compiler errors.
206-
207-
We have prioritization labels and a sync-blocker label, which are described below.
208-
- [P-low][p-low]: Requires attention (fix/response/evaluation) by a team member but isn't urgent.
209-
- [P-medium][p-medium]: Should be addressed by a team member until the next sync.
210-
- [P-high][p-high]: Should be immediately addressed and will require an out-of-cycle sync or a backport.
211-
- [L-sync-blocker][l-sync-blocker]: An issue that "blocks" a sync.
212-
Or rather: before the sync this should be addressed,
213-
e.g. by removing a lint again, so it doesn't hit beta/stable.
202+
To find things to fix, go to the [tracking issue][tracking_issue], find an issue that you like,
203+
and claim it with `@rustbot claim`.
204+
205+
As a general metric and always taking into account your skill and knowledge level, you can use this guide:
206+
207+
- 🟥 [ICEs][search_ice], these are compiler errors that causes Clippy to panic and crash. Usually involves high-level
208+
debugging, sometimes interacting directly with the upstream compiler. Difficult to fix but a great challenge that
209+
improves a lot developer workflows!
210+
211+
- 🟧 [Suggestion causes bug][sugg_causes_bug], Clippy suggested code that changed logic in some silent way.
212+
Unacceptable, as this may have disastrous consequences. Easier to fix than ICEs
213+
214+
- 🟨 [Suggestion causes error][sugg_causes_error], Clippy suggested code snippet that caused a compiler error
215+
when applied. We need to make sure that Clippy doesn't suggest using a variable twice at the same time or similar
216+
easy-to-happen occurrences.
217+
218+
- 🟩 [False positives][false_positive], a lint should not have fired, the easiest of them all, as this is "just"
219+
identifying the root of a false positive and making an exception for those cases.
220+
221+
Note that false negatives do not have priority unless the case is very clear, as they are a feature-request in a
222+
trench coat.
214223

215224
[triage]: https://forge.rust-lang.org/release/triage-procedure.html
216-
[I-ICE]: https://github.com/rust-lang/rust-clippy/labels/I-ICE
217-
[C-bug]: https://github.com/rust-lang/rust-clippy/labels/C-bug
218-
[p-low]: https://github.com/rust-lang/rust-clippy/labels/P-low
219-
[p-medium]: https://github.com/rust-lang/rust-clippy/labels/P-medium
220-
[p-high]: https://github.com/rust-lang/rust-clippy/labels/P-high
221-
[l-sync-blocker]: https://github.com/rust-lang/rust-clippy/labels/L-sync-blocker
225+
[search_ice]: https://github.com/rust-lang/rust-clippy/issues?q=sort%3Aupdated-desc+state%3Aopen+label%3A%22I-ICE%22
226+
[sugg_causes_bug]: https://github.com/rust-lang/rust-clippy/issues?q=sort%3Aupdated-desc%20state%3Aopen%20label%3AI-suggestion-causes-bug
227+
[sugg_causes_error]: https://github.com/rust-lang/rust-clippy/issues?q=sort%3Aupdated-desc%20state%3Aopen%20label%3AI-suggestion-causes-error%20
228+
[false_positive]: https://github.com/rust-lang/rust-clippy/issues?q=sort%3Aupdated-desc%20state%3Aopen%20label%3AI-false-positive
229+
[tracking_issue]: https://github.com/rust-lang/rust-clippy/issues/15086
222230

223231
## Contributions
224232

0 commit comments

Comments
 (0)