Skip to content

expand the issue template for new lints #15336

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.

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/new_lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,24 @@ body:
```
validations:
required: true
- type: textarea
id: comparison
attributes:
label: Comparision with existing lints
description: |
What makes this lint different from any existing lints that are similar, and how are those differences useful?

You can [use this playground template to see what existing lints are triggered by the bad code][playground]
(make sure to use "Tools > Clippy" and not "Build").
You can also look through the list of [rustc's allowed-by-default lints][allowed-by-default],
as those won't show up in the playground above.

[allowed-by-default]: https://doc.rust-lang.org/rustc/lints/listing/allowed-by-default.html

[playground]: https://play.rust-lang.org/?version=nightly&mode=debug&edition=2024&code=%23%21%5Bwarn%28clippy%3A%3Apedantic%29%5D%0A%23%21%5Bwarn%28clippy%3A%3Anursery%29%5D%0A%23%21%5Bwarn%28clippy%3A%3Arestriction%29%5D%0A%23%21%5Bwarn%28clippy%3A%3Aall%29%5D%0A%23%21%5Ballow%28clippy%3A%3Ablanket_clippy_restriction_lints%2C+reason+%3D+%22testing+to+see+if+any+restriction+lints+match+given+code%22%29%5D%0A%0A%2F%2F%21+Template+that+can+be+used+to+see+what+clippy+lints+a+given+piece+of+code+would+trigger
placeholder: Unlike `clippy::...`, the proposed lint would...
- type: textarea
id: context
attributes:
label: Additional Context
description: Any additional context that you believe may be relevant.