-
Notifications
You must be signed in to change notification settings - Fork 12.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rollup merge of #106831 - estebank:tickets_yaml, r=Mark-Simulacrum
Use GitHub yaml templates for ICE, Docs and Diagnostics tickets The GitHub yaml templates allow us to define HTML forms with validation for issue templates, instead of the current markdown based templates which only let us introduce text into the user editable text area. The form lets us make some fields mandatory, as well as add text that won't pollute the user's text and titles that won't be interfered with by enterprising users.
- Loading branch information
Showing
6 changed files
with
185 additions
and
129 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |