dnrops
/
rust
mirror of https://github.com/rust-lang/rust.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Use new template forms for issue templates 

GitHub has a new way to define issue templates. This gives an even more
consistent formatting of our issues.
This commit is contained in:
flip1995 2021-11-25 16:01:41 +01:00
parent 908815ce98
commit 11002c7f77
No known key found for this signature in database
GPG Key ID: 1CA0DF2AF59D68A5
12 changed files with 338 additions and 228 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
.github/ISSUE_TEMPLATE/blank_issue.md vendored
View File

@ -1,18 +0,0 @@
---
name: Blank Issue
about: Create a blank issue.
---
<!--
Additional labels can be added to this issue by including the following command
(without the space after the @ symbol):
@ rustbot label +<label>
Common labels for this issue type are:
* C-an-interesting-project
* C-enhancement
* C-question
* C-tracking-issue
-->

44
.github/ISSUE_TEMPLATE/blank_issue.yml vendored Normal file
View File

@ -0,0 +1,44 @@
name: Blank Issue
description: Create a blank issue.
body:
- type: markdown
attributes:
value: Thank you for filing an issue!
- type: textarea
id: problem
attributes:
label: Description
description: >
Please provide a discription of the issue, along with any information
you feel relevant to replicate it.
validations:
required: true
- type: textarea
id: version
attributes:
label: Version
description: "Rust version (`rustc -Vv`)"
placeholder: |
rustc 1.46.0-nightly (f455e46ea 2020-06-20)
binary: rustc
commit-hash: f455e46eae1a227d735091091144601b467e1565
commit-date: 2020-06-20
host: x86_64-unknown-linux-gnu
release: 1.46.0-nightly
LLVM version: 10.0
render: text
- type: textarea
id: labels
attributes:
label: Additional Labels
description: >
Additional labels can be added to this issue by including the following
command
placeholder: |
@rustbot label +<label>
Common labels for this issue type are:
* C-an-interesting-project
* C-enhancement
* C-question
* C-tracking-issue

43
.github/ISSUE_TEMPLATE/bug_report.md vendored
View File

@ -1,43 +0,0 @@
---
name: Bug Report
about: Create a bug report for Clippy
labels: C-bug
---
<!--
Thank you for filing a bug report! 🐛 Please provide a short summary of the bug,
along with any information you feel relevant to replicating the bug.
-->
I tried this code:
```rust
<code>
```
I expected to see this happen: *explanation*
Instead, this happened: *explanation*
### Meta
**Rust version (`rustc -Vv`):**
```
rustc 1.46.0-nightly (f455e46ea 2020-06-20)
binary: rustc
commit-hash: f455e46eae1a227d735091091144601b467e1565
commit-date: 2020-06-20
host: x86_64-unknown-linux-gnu
release: 1.46.0-nightly
LLVM version: 10.0
```
<!--
Additional labels can be added to this issue by including the following command
(without the space after the @ symbol):
@ rustbot label +<label>
Common labels for this issue type are:
* `I-suggestion-causes-error`
-->

57
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@ -0,0 +1,57 @@
name: Bug Report
description: Create a bug report for Clippy
labels: ["C-bug"]
body:
- type: markdown
attributes:
value: Thank you for filing a bug report! 🐛
- type: textarea
id: problem
attributes:
label: Summary
description: >
Please provide a short summary of the bug, along with any information
you feel relevant to replicate the bug.
validations:
required: true
- type: textarea
id: reproducer
attributes:
label: Reproducer
description: Please provide the code and steps to repoduce the bug
value: |
I tried this code:
```rust
<code>
```
I expected to see this happen:
Instead, this happened:
- type: textarea
id: version
attributes:
label: Version
description: "Rust version (`rustc -Vv`)"
placeholder: |
rustc 1.46.0-nightly (f455e46ea 2020-06-20)
binary: rustc
commit-hash: f455e46eae1a227d735091091144601b467e1565
commit-date: 2020-06-20
host: x86_64-unknown-linux-gnu
release: 1.46.0-nightly
LLVM version: 10.0
render: text
- type: textarea
id: labels
attributes:
label: Additional Labels
description: >
Additional labels can be added to this issue by including the following
command
placeholder: |
@rustbot label +<label>
Common labels for this issue type are:
* `I-suggestion-causes-error`

35
.github/ISSUE_TEMPLATE/false_negative.md vendored
View File

@ -1,35 +0,0 @@
---
name: Bug Report (False Negative)
about: Create a bug report about missing warnings from a lint
labels: C-bug, I-false-negative
---
<!--
Thank you for filing a bug report! 🐛 Please provide a short summary of the bug,
along with any information you feel relevant to replicating the bug.
-->
Lint name:
I tried this code:
```rust
<code>
```
I expected to see this happen: *explanation*
Instead, this happened: *explanation*
### Meta
**Rust version (`rustc -Vv`):**
```
rustc 1.46.0-nightly (f455e46ea 2020-06-20)
binary: rustc
commit-hash: f455e46eae1a227d735091091144601b467e1565
commit-date: 2020-06-20
host: x86_64-unknown-linux-gnu
release: 1.46.0-nightly
LLVM version: 10.0
```

50
.github/ISSUE_TEMPLATE/false_negative.yml vendored Normal file
View File

@ -0,0 +1,50 @@
name: Bug Report (False Negative)
description: Create a bug report about missing warnings from a lint
labels: ["C-bug", "I-false-negative"]
body:
- type: markdown
attributes:
value: Thank you for filing a bug report! 🐛
- type: textarea
id: problem
attributes:
label: Summary
description: >
Please provide a short summary of the bug, along with any information
you feel relevant to replicate the bug.
validations:
required: true
- type: input
id: lint-name
attributes:
label: Lint Name
description: Please provide the lint name.
- type: textarea
id: reproducer
attributes:
label: Reproducer
description: Please provide the code and steps to repoduce the bug
value: |
I tried this code:
```rust
<code>
```
I expected to see this happen:
Instead, this happened:
- type: textarea
id: version
attributes:
label: Version
description: "Rust version (`rustc -Vv`)"
placeholder: |
rustc 1.46.0-nightly (f455e46ea 2020-06-20)
binary: rustc
commit-hash: f455e46eae1a227d735091091144601b467e1565
commit-date: 2020-06-20
host: x86_64-unknown-linux-gnu
release: 1.46.0-nightly
LLVM version: 10.0
render: text

44
.github/ISSUE_TEMPLATE/false_positive.md vendored
View File

@ -1,44 +0,0 @@
---
name: Bug Report (False Positive)
about: Create a bug report about a wrongly emitted lint warning
labels: C-bug, I-false-positive
---
<!--
Thank you for filing a bug report! 🐛 Please provide a short summary of the bug,
along with any information you feel relevant to replicating the bug.
-->
Lint name:
I tried this code:
```rust
<code>
```
I expected to see this happen: *explanation*
Instead, this happened: *explanation*
### Meta
**Rust version (`rustc -Vv`):**
```
rustc 1.46.0-nightly (f455e46ea 2020-06-20)
binary: rustc
commit-hash: f455e46eae1a227d735091091144601b467e1565
commit-date: 2020-06-20
host: x86_64-unknown-linux-gnu
release: 1.46.0-nightly
LLVM version: 10.0
```
<!--
Additional labels can be added to this issue by including the following command
(without the space after the @ symbol):
@ rustbot label +<label>
Common labels for this issue type are:
* I-suggestion-causes-error
-->

68
.github/ISSUE_TEMPLATE/false_positive.yml vendored Normal file
View File

@ -0,0 +1,68 @@
name: Bug Report (False Positive)
description: Create a bug report about a wrongly emitted lint warning
labels: ["C-bug", "I-false-positive"]
body:
- type: markdown
attributes:
value: Thank you for filing a bug report! 🐛
- type: textarea
id: problem
attributes:
label: Summary
description: >
Please provide a short summary of the bug, along with any information
you feel relevant to replicate the bug.
validations:
required: true
- type: input
id: lint-name
attributes:
label: Lint Name
description: Please provide the lint name.
- type: textarea
id: reproducer
attributes:
label: Reproducer
description: >
Please provide the code and steps to repoduce the bug together with the
output from Clippy.
value: |
I tried this code:
```rust
<code>
```
I saw this happen:
```
<output>
```
I expected to see this happen:
- type: textarea
id: version
attributes:
label: Version
description: "Rust version (`rustc -Vv`)"
placeholder: |
rustc 1.46.0-nightly (f455e46ea 2020-06-20)
binary: rustc
commit-hash: f455e46eae1a227d735091091144601b467e1565
commit-date: 2020-06-20
host: x86_64-unknown-linux-gnu
release: 1.46.0-nightly
LLVM version: 10.0
render: text
- type: textarea
id: labels
attributes:
label: Additional Labels
description: >
Additional labels can be added to this issue by including the following
command
placeholder: |
@rustbot label +<label>
Common labels for this issue type are:
* `I-suggestion-causes-error`

52
.github/ISSUE_TEMPLATE/ice.md vendored
View File

@ -1,52 +0,0 @@
---
name: Internal Compiler Error
about: Create a report for an internal compiler error in Clippy.
labels: C-bug, I-ICE
---
<!--
Thank you for finding an Internal Compiler Error! 🧊 If possible, try to provide
a minimal verifiable example. You can read "Rust Bug Minimization Patterns" for
how to create smaller examples.
http://blog.pnkfx.org/blog/2019/11/18/rust-bug-minimization-patterns/
-->
### Code
```rust
<code>
```
### Meta
**Rust version (`rustc -Vv`):**
```
rustc 1.46.0-nightly (f455e46ea 2020-06-20)
binary: rustc
commit-hash: f455e46eae1a227d735091091144601b467e1565
commit-date: 2020-06-20
host: x86_64-unknown-linux-gnu
release: 1.46.0-nightly
LLVM version: 10.0
```
### Error output
```
<output>
```
<!--
Include a backtrace in the code block by setting `RUST_BACKTRACE=1` in your
environment. E.g. `RUST_BACKTRACE=1 cargo clippy`.
-->
<details><summary>Backtrace</summary>
<p>
```
<backtrace>
```
</p>
</details>

48
.github/ISSUE_TEMPLATE/ice.yml vendored Normal file
View File

@ -0,0 +1,48 @@
name: Internal Compiler Error
description: Create a report for an internal compiler error (ICE) in Clippy.
labels: ["C-bug", "I-ICE"]
body:
- type: markdown
attributes:
value: Thank you for finding an Internal Compiler Error! 🧊
- type: textarea
id: problem
attributes:
label: Summary
description: |
If possible, try to provide a minimal verifiable example. You can read ["Rust Bug Minimization Patterns"][mve] for how to create smaller examples. Otherwise, provide the crate where the ICE occured.
[mve]: http://blog.pnkfx.org/blog/2019/11/18/rust-bug-minimization-patterns/
validations:
required: true
- type: textarea
id: version
attributes:
label: Version
description: "Rust version (`rustc -Vv`)"
placeholder: |
rustc 1.46.0-nightly (f455e46ea 2020-06-20)
binary: rustc
commit-hash: f455e46eae1a227d735091091144601b467e1565
commit-date: 2020-06-20
host: x86_64-unknown-linux-gnu
release: 1.46.0-nightly
LLVM version: 10.0
render: text
- type: textarea
id: error
attributes:
label: Error output
description: >
Include a backtrace in the code block by setting `RUST_BACKTRACE=1` in
your environment. E.g. `RUST_BACKTRACE=1 cargo clippy`.
value: |
<details><summary>Backtrace</summary>
<p>
```
<backtrace>
```
</p>
</details>

36
.github/ISSUE_TEMPLATE/new_lint.md vendored
View File

@ -1,36 +0,0 @@
---
name: New lint suggestion
about: Suggest a new Clippy lint.
labels: A-lint
---
### What it does
*What does this lint do?*
### Categories (optional)
- Kind: *See <https://github.com/rust-lang/rust-clippy/blob/master/README.md#clippy> for list of lint kinds*
*What is the advantage of the recommended code over the original code*
For example:
- Remove bounds check inserted by ...
- Remove the need to duplicate/store ...
- Remove typo ...
### Drawbacks
None.
### Example
```rust
<code>
```
Could be written as:
```rust
<code>
```

71
.github/ISSUE_TEMPLATE/new_lint.yml vendored Normal file
View File

@ -0,0 +1,71 @@
name: New lint suggestion
description: Suggest a new Clippy lint.
labels: ["A-lint"]
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: input
id: lint-name
attributes:
label: Lint Name
description: Please provide the lint name.
- type: dropdown
id: category
attributes:
label: Category
description: >
What category should this lint go into? If you're unsure you can select
multiple categories. You can find a category description in the
`README`.
multiple: true
options:
- correctness
- suspicious
- style
- complexity
- perf
- pedantic
- restriction
- cargo
- 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: |
```rust
<code>
```
Could be written as:
```rust
<code>
```
validations:
required: true