Skip to content

Commit 68db374

Browse files
authored
chore(gh): Add new-lint issue template (rust-lang#15575)
### What does this PR try to resolve? We aren't quite ready for writing lints (waiting on an annotate-snippets release) but I wanted to start recording some lint ideas I had. ### How should we test and review this PR? Based on clippy's which I assumed would be a good starting point. There are more area we'll need to fill out during discussion, like the lint name, what primary group the lint would be in, etc. ### Additional information
2 parents c2c636a + 5661fb8 commit 68db374

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

.github/ISSUE_TEMPLATE/new_lint.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: New lint suggestion
2+
description: Suggest a new Cargo lint.
3+
labels: ["A-new-lint", "S-triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: Thank you for your lint idea!
8+
- type: textarea
9+
id: what
10+
attributes:
11+
label: What it does
12+
description: What does this lint do?
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: advantage
17+
attributes:
18+
label: Advantage
19+
description: >
20+
What is the advantage of the recommended code over the original code?
21+
placeholder: |
22+
- Remove bounds check inserted by ...
23+
- Remove the need to duplicate/store ...
24+
- Remove typo ...
25+
- type: textarea
26+
id: drawbacks
27+
attributes:
28+
label: Drawbacks
29+
description: What might be possible drawbacks of such a lint?
30+
- type: textarea
31+
id: example
32+
attributes:
33+
label: Example
34+
description: >
35+
Include a short example showing when the lint should trigger together
36+
with the improved code.
37+
value: |
38+
```toml
39+
<code>
40+
```
41+
42+
Could be written as:
43+
44+
```toml
45+
<code>
46+
```
47+
validations:
48+
required: true

0 commit comments

Comments
 (0)