Skip to content

Commit 5e1e9b0

Browse files
committed
Auto merge of #7600 - xFrednet:0000-update-issue-templates, r=camsteffen
Updated issue templates(formatting and rustbot label reference) This PR updates our issue templates. The changes are: 1. **Make the *Meta* section smaller and not indented** The current format sometimes gets messed up when a user simply pasts the rustc version into the issue without indenting it to match the code block. Removing the indention should hopefully help with formatting in the future. <details><summary>Example of messed up formatting </summary> ![image](https://user-images.githubusercontent.com/17087237/130811809-2b9bc58e-c13f-4338-b34e-18648a5de413.png) </details> Additionally, I've removed the Version of Clippy from the template. Every issue that I have seen had matching rustc and Clippy versions, and just asking for `rustc -Vv` makes the issue look cleaner IMO. 2. **Add a comment explaining how additional labels can be added with ``@rustbot` label +<label>`. The explanation looks like this:** ``` <!-- Additional labels can be added to this issue by including the following command: `@rustbot` label +<label> Common labels for this issue type are: * `I-suggestion-causes-error` --> ``` The example ``@rustbot`` call can sadly not be marked as code inside a comment block. But the example will not cause the bot to add any labels. See #7599 --- changelog: none cc: `@rust-lang/clippy`
2 parents a4a3f61 + 10909ae commit 5e1e9b0

File tree

5 files changed

+70
-55
lines changed

5 files changed

+70
-55
lines changed

.github/ISSUE_TEMPLATE/blank_issue.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,16 @@
22
name: Blank Issue
33
about: Create a blank issue.
44
---
5+
6+
7+
<!--
8+
Additional labels can be added to this issue by including the following command:
9+
10+
@rustbot label +<label>
11+
12+
Common labels for this issue type are:
13+
* C-an-interesting-project
14+
* C-enhancement
15+
* C-question
16+
* C-tracking-issue
17+
-->

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 17 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -20,28 +20,23 @@ Instead, this happened: *explanation*
2020

2121
### Meta
2222

23-
- `cargo clippy -V`: e.g. clippy 0.0.212 (f455e46 2020-06-20)
24-
- `rustc -Vv`:
25-
```
26-
rustc 1.46.0-nightly (f455e46ea 2020-06-20)
27-
binary: rustc
28-
commit-hash: f455e46eae1a227d735091091144601b467e1565
29-
commit-date: 2020-06-20
30-
host: x86_64-unknown-linux-gnu
31-
release: 1.46.0-nightly
32-
LLVM version: 10.0
33-
```
23+
**Rust version (`rustc -Vv`):**
24+
25+
```
26+
rustc 1.46.0-nightly (f455e46ea 2020-06-20)
27+
binary: rustc
28+
commit-hash: f455e46eae1a227d735091091144601b467e1565
29+
commit-date: 2020-06-20
30+
host: x86_64-unknown-linux-gnu
31+
release: 1.46.0-nightly
32+
LLVM version: 10.0
33+
```
3434

3535
<!--
36-
Include a backtrace in the code block by setting `RUST_BACKTRACE=1` in your
37-
environment. E.g. `RUST_BACKTRACE=1 cargo clippy`.
36+
Additional labels can be added to this issue by including the following command:
37+
38+
@rustbot label +<label>
39+
40+
Common labels for this issue type are:
41+
* `I-suggestion-causes-error`
3842
-->
39-
<details><summary>Backtrace</summary>
40-
<p>
41-
42-
```
43-
<backtrace>
44-
```
45-
46-
</p>
47-
</details>

.github/ISSUE_TEMPLATE/false_negative.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,14 @@ Instead, this happened: *explanation*
2222

2323
### Meta
2424

25-
- `cargo clippy -V`: e.g. clippy 0.0.212 (f455e46 2020-06-20)
26-
- `rustc -Vv`:
27-
```
28-
rustc 1.46.0-nightly (f455e46ea 2020-06-20)
29-
binary: rustc
30-
commit-hash: f455e46eae1a227d735091091144601b467e1565
31-
commit-date: 2020-06-20
32-
host: x86_64-unknown-linux-gnu
33-
release: 1.46.0-nightly
34-
LLVM version: 10.0
35-
```
25+
**Rust version (`rustc -Vv`):**
26+
27+
```
28+
rustc 1.46.0-nightly (f455e46ea 2020-06-20)
29+
binary: rustc
30+
commit-hash: f455e46eae1a227d735091091144601b467e1565
31+
commit-date: 2020-06-20
32+
host: x86_64-unknown-linux-gnu
33+
release: 1.46.0-nightly
34+
LLVM version: 10.0
35+
```

.github/ISSUE_TEMPLATE/false_positive.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,22 @@ Instead, this happened: *explanation*
2222

2323
### Meta
2424

25-
- `cargo clippy -V`: e.g. clippy 0.0.212 (f455e46 2020-06-20)
26-
- `rustc -Vv`:
27-
```
28-
rustc 1.46.0-nightly (f455e46ea 2020-06-20)
29-
binary: rustc
30-
commit-hash: f455e46eae1a227d735091091144601b467e1565
31-
commit-date: 2020-06-20
32-
host: x86_64-unknown-linux-gnu
33-
release: 1.46.0-nightly
34-
LLVM version: 10.0
35-
```
25+
**Rust version (`rustc -Vv`):**
26+
```
27+
rustc 1.46.0-nightly (f455e46ea 2020-06-20)
28+
binary: rustc
29+
commit-hash: f455e46eae1a227d735091091144601b467e1565
30+
commit-date: 2020-06-20
31+
host: x86_64-unknown-linux-gnu
32+
release: 1.46.0-nightly
33+
LLVM version: 10.0
34+
```
35+
36+
<!--
37+
Additional labels can be added to this issue by including the following command:
38+
39+
@rustbot label +<label>
40+
41+
Common labels for this issue type are:
42+
* I-suggestion-causes-error
43+
-->

.github/ISSUE_TEMPLATE/ice.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,16 @@ http://blog.pnkfx.org/blog/2019/11/18/rust-bug-minimization-patterns/
2020

2121
### Meta
2222

23-
- `cargo clippy -V`: e.g. clippy 0.0.212 (f455e46 2020-06-20)
24-
- `rustc -Vv`:
25-
```
26-
rustc 1.46.0-nightly (f455e46ea 2020-06-20)
27-
binary: rustc
28-
commit-hash: f455e46eae1a227d735091091144601b467e1565
29-
commit-date: 2020-06-20
30-
host: x86_64-unknown-linux-gnu
31-
release: 1.46.0-nightly
32-
LLVM version: 10.0
33-
```
23+
**Rust version (`rustc -Vv`):**
24+
```
25+
rustc 1.46.0-nightly (f455e46ea 2020-06-20)
26+
binary: rustc
27+
commit-hash: f455e46eae1a227d735091091144601b467e1565
28+
commit-date: 2020-06-20
29+
host: x86_64-unknown-linux-gnu
30+
release: 1.46.0-nightly
31+
LLVM version: 10.0
32+
```
3433

3534
### Error output
3635

0 commit comments

Comments
 (0)