Use GitHub yaml templates for ICE, Docs and Diagnostics tickets

This commit is contained in:
Esteban Küber 2023-01-14 01:17:18 +00:00
parent 0b90256ada
commit a1614d0cf8
6 changed files with 185 additions and 129 deletions

View File

@ -1,46 +0,0 @@
---
name: Diagnostic issue
about: Create a bug report or feature request for a change to `rustc`'s error output
labels: A-diagnostics, T-compiler
---
<!--
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.
If you cannot produce a minimal reproduction case (something that would work in
isolation), please provide the steps or even link to a repository that causes
the problematic output to occur.
-->
Given the following code: <!-- Please provide a link to play.rust-lang.org -->
```rust
<code>
```
The current output is:
```
<rustc output>
```
<!-- The following is not always necessary. -->
Ideally the output should look like:
```
<proposed output>
```
<!--
If the problem is not self-explanatory, please provide a rationale for the
change.
-->
<!--
If dramatically different output is caused by small changes, consider also
adding them here.
If you're using the stable version of the compiler, you should also check if the
bug also exists in the beta or nightly versions. The output might also be
different depending on the Edition.
-->

65
.github/ISSUE_TEMPLATE/diagnostics.yaml vendored Normal file
View File

@ -0,0 +1,65 @@
name: Diagnostic issue
description: Create a bug report or feature request for a change to `rustc`'s error output
labels: ["A-diagnostics", "T-compiler"]
body:
- type: markdown
attributes:
value: |
Thank you for filing a diagnostics bug report! 🐛
Please provide a short summary of the bug, along with any information you feel relevant to replicating the bug.
If you cannot produce a minimal reproduction case (something that would work in isolation), please provide the steps or even link to a repository that causes the problematic output to occur.
- type: textarea
id: code
attributes:
label: Code
description: Please provide code that can reproduce the problem
placeholder: code
render: Rust
validations:
required: true
- type: textarea
id: output
attributes:
label: Current output
description: Please provide the `rustc` output you see
placeholder: rustc output
render: Shell
validations:
required: true
- type: textarea
id: desired-output
attributes:
label: Desired output
description: Please provide what the output *should* be
placeholder: proposed output
render: Shell
validations:
required: false
- type: textarea
id: rationale
attributes:
label: Rationale and extra context
description: If the problem is not self-explanatory, please provide a rationale for the change.
validations:
required: false
- type: textarea
id: other-output
attributes:
label: Other cases
description: If dramatically different output is caused by small changes, consider also adding them here.
render: Rust
validations:
required: false
- type: markdown
attributes:
value: |
If you're using the stable version of the compiler, you should also check if the bug also exists in the beta or nightly versions. The output might also be different depending on the Edition.
- type: textarea
id: extra
attributes:
label: Anything else?
description: If you have more details you want to give us to reproduce this issue, please add it here
validations:
required: false

View File

@ -1,31 +0,0 @@
---
name: Documentation problem
about: Create a report for a documentation problem.
labels: A-docs
---
<!--
Thank you for finding a documentation problem! 📚
Documentation problems might be grammatical issues, typos, or unclear wording, please provide details regarding the documentation including where it is present.
Note: If your issue is for one of these, please use their dedicated issue tracker instead:
- The Rust Book: https://github.com/rust-lang/book/issues
- Rust by Example: https://github.com/rust-lang/rust-by-example/issues
- The Edition Guide: https://github.com/rust-lang/edition-guide/issues
- The Cargo Book: https://github.com/rust-lang/cargo/issues
- The Clippy Book: https://github.com/rust-lang/rust-clippy/issues
- The Reference: https://github.com/rust-lang/reference/issues
- The Rustonomicon: https://github.com/rust-lang/nomicon/issues
- The Embedded Book: https://github.com/rust-embedded/book/issues
All other documentation issues should be filed here.
Or, if you find an issue related to rustdoc (e.g. doctest, rustdoc UI), please use the bug report or blank issue template instead.
-->
### Location
### Summary

View File

@ -0,0 +1,38 @@
name: Documentation problem
description: Create a report for a documentation problem.
labels: ["A-docs"]
body:
- type: markdown
attributes:
value: |
Thank you for finding a documentation problem! 📚
Documentation problems might be grammatical issues, typos, or unclear wording, please provide details regarding the documentation including where it is present.
Note: If your issue is for one of these, please use their dedicated issue tracker instead:
- [The Rust Book](https://github.com/rust-lang/book/issues)
- [Rust by Example](https://github.com/rust-lang/rust-by-example/issues)
- [The Edition Guide](https://github.com/rust-lang/edition-guide/issues)
- [The Cargo Book](https://github.com/rust-lang/cargo/issues)
- [The Clippy Book](https://github.com/rust-lang/rust-clippy/issues)
- [The Reference](https://github.com/rust-lang/reference/issues)
- [The Rustonomicon](https://github.com/rust-lang/nomicon/issues)
- [The Embedded Book](https://github.com/rust-embedded/book/issues)
All other documentation issues should be filed here.
Or, if you find an issue related to rustdoc (e.g. doctest, rustdoc UI), please use the bug report or blank issue template instead.
- type: textarea
id: location
attributes:
label: Location
validations:
required: true
- type: textarea
id: summary
attributes:
label: Summary
validations:
required: true

View File

@ -1,52 +0,0 @@
---
name: Internal Compiler Error
about: Create a report for an internal compiler error in rustc.
labels: C-bug, I-ICE, T-compiler
---
<!--
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
<!--
If you're using the stable version of the compiler, you should also check if the
bug also exists in the beta or nightly versions.
-->
`rustc --version --verbose`:
```
<version>
```
### Error output
```
<output>
```
<!--
Include a backtrace in the code block by setting `RUST_BACKTRACE=1` in your
environment. E.g. `RUST_BACKTRACE=1 cargo build`.
-->
<details><summary><strong>Backtrace</strong></summary>
<p>
```
<backtrace>
```
</p>
</details>

82
.github/ISSUE_TEMPLATE/ice.yaml vendored Normal file
View File

@ -0,0 +1,82 @@
name: Internal Compiler Error
description: Create a report for an internal compiler error in `rustc`
labels: ["C-bug", "I-ICE", "T-compiler"]
title: "[ICE]: "
body:
- type: markdown
attributes:
value: |
Thank you for finding an Internal Compiler Error! 🧊
If possible, try to provide a minimal verifiable example.
You can read "[Rust Bug Minimization Patterns](http://blog.pnkfx.org/blog/2019/11/18/rust-bug-minimization-patterns/)" for how to create smaller examples.
- type: textarea
id: code
attributes:
label: Code
description: Please provide code or a link to a repository that can reproduce the problem
placeholder: code
render: Rust
validations:
required: false
- type: checkboxes
attributes:
label: Affected release channels
description: If you're using the stable version of the compiler, you should also check if the bug also exists in the beta or nightly versions
options:
- label: Previous Stable
required: false
- label: Current Stable
required: false
- label: Current Beta
required: false
- label: Current Nightly
required: false
- type: textarea
id: version
attributes:
label: Rust Version
description: Please provide the `rustc` version, `rustc --version --verbose`
placeholder: |
$ rustc --version --verbose
rustc 1.XX.Y (SHORTHASH DATE)
binary: rustc
commit-hash: LONGHASHVALUE
commit-date: DATE
host: PLATFORMTRIPLE
release: 1.XX.Y
LLVM version: XX.YY.ZZ
render: Shell
validations:
required: true
- type: textarea
id: output
attributes:
label: Current error output
description: Please provide the `rustc` output you see
placeholder: output
render: Shell
validations:
required: false
- type: textarea
id: backtrace
attributes:
label: Backtrace
description: Include a backtrace in the code block by setting `RUST_BACKTRACE=full` in your environment, e.g. `RUST_BACKTRACE=full cargo build`
render: Shell
validations:
required: true
- type: textarea
id: extra
attributes:
label: Anything else?
description: If you have more details you want to give us to reproduce this issue, please add it here
validations:
required: false