Skip to content

chore(gh): Add new-lint issue template #15575

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

Merged
merged 1 commit into from
May 22, 2025
Merged
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
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/new_lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: New lint suggestion
description: Suggest a new Cargo lint.
labels: ["A-new-lint", "S-triage"]
body:
- type: markdown
attributes:
value: Thank you for your lint idea!
- type: textarea
id: what
attributes:
label: What it does
description: What does this lint do?
validations:
required: true
- type: textarea
id: advantage
attributes:
label: Advantage
description: >
What is the advantage of the recommended code over the original code?
placeholder: |
- Remove bounds check inserted by ...
- Remove the need to duplicate/store ...
- Remove typo ...
- type: textarea
id: drawbacks
attributes:
label: Drawbacks
description: What might be possible drawbacks of such a lint?
- type: textarea
id: example
attributes:
label: Example
description: >
Include a short example showing when the lint should trigger together
with the improved code.
value: |
```toml
<code>
```

Could be written as:

```toml
<code>
```
validations:
required: true