|
| 1 | +# IMPORTANT: FEATURE FREEZE |
| 2 | + |
| 3 | +This is a temporary notice. |
| 4 | + |
| 5 | +From the 26th of June until the 18th of September we will perform a feature freeze. Only bugfix PRs will be reviewed |
| 6 | +except already open ones. Every feature-adding PR opened in between those dates will be moved into a |
| 7 | +milestone to be reviewed separately at another time. |
| 8 | + |
| 9 | +We do this because of the long backlog of bugs that need to be addressed |
| 10 | +in order to continue being the state-of-the-art linter that Clippy has become known for being. |
| 11 | + |
| 12 | +## For contributors |
| 13 | + |
| 14 | +If you are a contributor or are planning to become one, **please do not open a lint-adding PR**, we have lots of open |
| 15 | +bugs of all levels of difficulty that you can address instead! |
| 16 | + |
| 17 | +We currently have about 800 lints, each one posing a maintainability challenge that needs to account to every possible |
| 18 | +use case of the whole ecosystem. Bugs are natural in every software, but the Clippy team considers that Clippy needs a |
| 19 | +refinement period. |
| 20 | + |
| 21 | +If you open a PR at this time, we will not review it but push it into a milestone until the refinement period ends, |
| 22 | +adding additional load into our reviewing schedules. |
| 23 | + |
| 24 | +## I want to help, what can I do |
| 25 | + |
| 26 | +Thanks a lot to everyone who wants to help Clippy become better software in this feature freeze period! |
| 27 | +If you'd like to help, making a bugfix, making sure that it works, and opening a PR is a great step! |
| 28 | + |
| 29 | +To find things to fix, go to the [tracking issue][tracking_issue], find an issue that you like, go there and claim that |
| 30 | +issue with `@rustbot claim`. |
| 31 | + |
| 32 | +As a general metric and always taking into account your skill and knowledge level, you can use this guide: |
| 33 | + |
| 34 | +- 🟥 [ICEs][search_ice], these are compiler errors that causes Clippy to panic and crash. Usually involves high-level |
| 35 | +debugging, sometimes interacting directly with the upstream compiler. Difficult to fix but a great challenge that |
| 36 | +improves a lot developer workflows! |
| 37 | + |
| 38 | +- 🟧 [Suggestion causes bug][sugg_causes_bug], Clippy suggested code that changed logic in some silent way. |
| 39 | +Unacceptable, as this may have disastrous consequences. Easier to fix than ICEs |
| 40 | + |
| 41 | +- 🟨 [Suggestion causes error][sugg_causes_error], Clippy suggested code snippet that caused a compiler error |
| 42 | +when applied. We need to make sure that Clippy doesn't suggest using a variable twice at the same time or similar |
| 43 | +easy-to-happen occurrences. |
| 44 | + |
| 45 | +- 🟩 [False positives][false_positive], a lint should not have fired, the easiest of them all, as this is "just" |
| 46 | +identifying the root of a false positive and making an exception for those cases. |
| 47 | + |
| 48 | +Note that false negatives do not have priority unless the case is very clear, as they are a feature-request in a |
| 49 | +trench coat. |
| 50 | + |
| 51 | +[search_ice]: https://github.com/rust-lang/rust-clippy/issues?q=sort%3Aupdated-desc+state%3Aopen+label%3A%22I-ICE%22 |
| 52 | +[sugg_causes_bug]: https://github.com/rust-lang/rust-clippy/issues?q=sort%3Aupdated-desc%20state%3Aopen%20label%3AI-suggestion-causes-bug |
| 53 | +[sugg_causes_error]: https://github.com/rust-lang/rust-clippy/issues?q=sort%3Aupdated-desc%20state%3Aopen%20label%3AI-suggestion-causes-error%20 |
| 54 | +[false_positive]: https://github.com/rust-lang/rust-clippy/issues?q=sort%3Aupdated-desc%20state%3Aopen%20label%3AI-false-positive |
| 55 | +[tracking_issue]: https://github.com/rust-lang/rust-clippy/issues/15086 |
0 commit comments