Skip to content

Commit 2e30e52

Browse files
matthiaskrgrmatthiaskrgr
authored
Rollup merge of rust-lang#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.
2 parents 8c538f7 + a1614d0 commit 2e30e52

File tree

6 files changed

+185
-129
lines changed

6 files changed

+185
-129
lines changed

‎.github/ISSUE_TEMPLATE/diagnostics.md‎

Lines changed: 0 additions & 46 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/diagnostics.yaml‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: Diagnostic issue
2+
description: Create a bug report or feature request for a change to `rustc`'s error output
3+
labels: ["A-diagnostics", "T-compiler"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for filing a diagnostics bug report! 🐛
9+
10+
Please provide a short summary of the bug, along with any information you feel relevant to replicating the bug.
11+
12+
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.
13+
- type: textarea
14+
id: code
15+
attributes:
16+
label: Code
17+
description: Please provide code that can reproduce the problem
18+
placeholder: code
19+
render: Rust
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: output
24+
attributes:
25+
label: Current output
26+
description: Please provide the `rustc` output you see
27+
placeholder: rustc output
28+
render: Shell
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: desired-output
33+
attributes:
34+
label: Desired output
35+
description: Please provide what the output *should* be
36+
placeholder: proposed output
37+
render: Shell
38+
validations:
39+
required: false
40+
- type: textarea
41+
id: rationale
42+
attributes:
43+
label: Rationale and extra context
44+
description: If the problem is not self-explanatory, please provide a rationale for the change.
45+
validations:
46+
required: false
47+
- type: textarea
48+
id: other-output
49+
attributes:
50+
label: Other cases
51+
description: If dramatically different output is caused by small changes, consider also adding them here.
52+
render: Rust
53+
validations:
54+
required: false
55+
- type: markdown
56+
attributes:
57+
value: |
58+
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.
59+
- type: textarea
60+
id: extra
61+
attributes:
62+
label: Anything else?
63+
description: If you have more details you want to give us to reproduce this issue, please add it here
64+
validations:
65+
required: false

‎.github/ISSUE_TEMPLATE/documentation.md‎

Lines changed: 0 additions & 31 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/documentation.yaml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Documentation problem
2+
description: Create a report for a documentation problem.
3+
labels: ["A-docs"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for finding a documentation problem! 📚
9+
10+
Documentation problems might be grammatical issues, typos, or unclear wording, please provide details regarding the documentation including where it is present.
11+
12+
Note: If your issue is for one of these, please use their dedicated issue tracker instead:
13+
- [The Rust Book](https://github.com/rust-lang/book/issues)
14+
- [Rust by Example](https://github.com/rust-lang/rust-by-example/issues)
15+
- [The Edition Guide](https://github.com/rust-lang/edition-guide/issues)
16+
- [The Cargo Book](https://github.com/rust-lang/cargo/issues)
17+
- [The Clippy Book](https://github.com/rust-lang/rust-clippy/issues)
18+
- [The Reference](https://github.com/rust-lang/reference/issues)
19+
- [The Rustonomicon](https://github.com/rust-lang/nomicon/issues)
20+
- [The Embedded Book](https://github.com/rust-embedded/book/issues)
21+
22+
All other documentation issues should be filed here.
23+
24+
Or, if you find an issue related to rustdoc (e.g. doctest, rustdoc UI), please use the bug report or blank issue template instead.
25+
26+
- type: textarea
27+
id: location
28+
attributes:
29+
label: Location
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: summary
35+
attributes:
36+
label: Summary
37+
validations:
38+
required: true

‎.github/ISSUE_TEMPLATE/ice.md‎

Lines changed: 0 additions & 52 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/ice.yaml‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
name: Internal Compiler Error
2+
description: Create a report for an internal compiler error in `rustc`
3+
labels: ["C-bug", "I-ICE", "T-compiler"]
4+
title: "[ICE]: "
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for finding an Internal Compiler Error! 🧊
10+
11+
If possible, try to provide a minimal verifiable example.
12+
13+
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.
14+
15+
- type: textarea
16+
id: code
17+
attributes:
18+
label: Code
19+
description: Please provide code or a link to a repository that can reproduce the problem
20+
placeholder: code
21+
render: Rust
22+
validations:
23+
required: false
24+
25+
- type: checkboxes
26+
attributes:
27+
label: Affected release channels
28+
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
29+
options:
30+
- label: Previous Stable
31+
required: false
32+
- label: Current Stable
33+
required: false
34+
- label: Current Beta
35+
required: false
36+
- label: Current Nightly
37+
required: false
38+
39+
- type: textarea
40+
id: version
41+
attributes:
42+
label: Rust Version
43+
description: Please provide the `rustc` version, `rustc --version --verbose`
44+
placeholder: |
45+
$ rustc --version --verbose
46+
rustc 1.XX.Y (SHORTHASH DATE)
47+
binary: rustc
48+
commit-hash: LONGHASHVALUE
49+
commit-date: DATE
50+
host: PLATFORMTRIPLE
51+
release: 1.XX.Y
52+
LLVM version: XX.YY.ZZ
53+
render: Shell
54+
validations:
55+
required: true
56+
57+
- type: textarea
58+
id: output
59+
attributes:
60+
label: Current error output
61+
description: Please provide the `rustc` output you see
62+
placeholder: output
63+
render: Shell
64+
validations:
65+
required: false
66+
67+
- type: textarea
68+
id: backtrace
69+
attributes:
70+
label: Backtrace
71+
description: Include a backtrace in the code block by setting `RUST_BACKTRACE=full` in your environment, e.g. `RUST_BACKTRACE=full cargo build`
72+
render: Shell
73+
validations:
74+
required: true
75+
76+
- type: textarea
77+
id: extra
78+
attributes:
79+
label: Anything else?
80+
description: If you have more details you want to give us to reproduce this issue, please add it here
81+
validations:
82+
required: false

0 commit comments

Comments
 (0)