Skip to content

Commit 49d78fc

Browse files
committed
Add GitHub issue templates
1 parent ce361fb commit 49d78fc

File tree

5 files changed

+163
-0
lines changed

5 files changed

+163
-0
lines changed

.github/ISSUE_TEMPLATE/blank_issue.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
name: Blank Issue
3+
about: Create a blank issue.
4+
---

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
name: Bug Report
3+
about: Create a bug report for Rust.
4+
labels: C-bug
5+
---
6+
<!--
7+
Thank you for filing a bug report! 🐛 Please provide a short summary of the bug,
8+
along with any information you feel relevant to replicating the bug.
9+
-->
10+
11+
I tried this code:
12+
13+
```rust
14+
<code>
15+
```
16+
17+
I expected to see this happen: *explanation*
18+
19+
Instead, this happened: *explanation*
20+
21+
### Meta
22+
<!--
23+
If you're using the stable version of the compiler, you should also check if the
24+
bug also exists in the beta or nightly versions.
25+
-->
26+
27+
`rustc --version --verbose`:
28+
```
29+
<version>
30+
```
31+
32+
<!--
33+
Include a backtrace in the code block by setting `RUST_BACKTRACE=1` in your
34+
environment. E.g. `RUST_BACKTRACE=1 cargo build`.
35+
-->
36+
<details><summary>Backtrace</summary>
37+
<p>
38+
39+
```
40+
<backtrace>
41+
```
42+
43+
</p>
44+
</details>

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Rust Programming Language Forum
4+
url: https://users.rust-lang.org
5+
about: Please ask and answer questions about Rust here.

.github/ISSUE_TEMPLATE/ice.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
name: Internal Compiler Error
3+
about: Create a report for an internal compiler error in rustc.
4+
labels: C-bug, I-ICE, T-compiler
5+
---
6+
<!--
7+
Thank you for finding an Internal Compiler Error! 🧊 If possible, try to provide
8+
a minimal verifiable example. You can read "Rust Bug Minimization Patterns" for
9+
how to create smaller examples.
10+
11+
http://blog.pnkfx.org/blog/2019/11/18/rust-bug-minimization-patterns/
12+
13+
-->
14+
15+
### Code
16+
17+
```
18+
<code>
19+
```
20+
21+
22+
### Meta
23+
<!--
24+
If you're using the stable version of the compiler, you should also check if the
25+
bug also exists in the beta or nightly versions.
26+
-->
27+
28+
`rustc --version --verbose`:
29+
```
30+
<version>
31+
```
32+
33+
### Error output
34+
35+
```
36+
<output>
37+
```
38+
39+
<!--
40+
Include a backtrace in the code block by setting `RUST_BACKTRACE=1` in your
41+
environment. E.g. `RUST_BACKTRACE=1 cargo build`.
42+
-->
43+
<details><summary><strong>Backtrace</strong></summary>
44+
<p>
45+
46+
```
47+
<backtrace>
48+
```
49+
50+
</p>
51+
</details>
52+
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
name: Tracking Issue
3+
about: A tracking issue for a feature in Rust.
4+
title: Tracking Issue for XXX
5+
labels: C-tracking-issue
6+
---
7+
<!--
8+
Thank you for creating a tracking issue! 📜 Tracking issues are for tracking a
9+
feature from implementation to stabilisation. Make sure to include the relevant
10+
RFC for the feature if it has one. Otherwise provide a short summary of the
11+
feature and link any relevant PRs or issues, and remove any sections that are
12+
not relevant to the feature.
13+
14+
Remember to add team labels to the tracking issue.
15+
For a language team feature, this would e.g., be `T-lang`.
16+
Such a feature should also be labeled with e.g., `F-my_feature`.
17+
This label is used to associate issues (e.g., bugs and design questions) to the feature.
18+
-->
19+
20+
This is a tracking issue for the RFC "XXX" (rust-lang/rfcs#NNN).
21+
The feature gate for the issue is `#![feature(FFF)]`.
22+
23+
### About tracking issues
24+
25+
Tracking issues are used to record the overall progress of implementation.
26+
They are also uses as hubs connecting to other relevant issues, e.g., bugs or open design questions.
27+
A tracking issue is however *not* meant for large scale discussion, questions, or bug reports about a feature.
28+
Instead, open a dedicated issue for the specific matter and add the relevant feature gate label.
29+
30+
### Steps
31+
<!--
32+
Include each step required to complete the feature. Typically this is a PR
33+
implementing a feature, followed by a PR that stabilises the feature. However
34+
for larger features an implementation could be broken up into multiple PRs.
35+
-->
36+
37+
- [ ] Implement the RFC (cc @rust-lang/XXX -- can anyone write up mentoring
38+
instructions?)
39+
- [ ] Adjust documentation ([see instructions on rustc-guide][doc-guide])
40+
- [ ] Stabilization PR ([see instructions on rustc-guide][stabilization-guide])
41+
42+
[stabilization-guide]: https://rust-lang.github.io/rustc-guide/stabilization_guide.html#stabilization-pr
43+
[doc-guide]: https://rust-lang.github.io/rustc-guide/stabilization_guide.html#documentation-prs
44+
45+
### Unresolved Questions
46+
<!--
47+
Include any open questions that need to be answered before the feature can be
48+
stabilised.
49+
-->
50+
51+
XXX --- list all the "unresolved questions" found in the RFC to ensure they are
52+
not forgotten
53+
54+
### Implementation history
55+
56+
<!--
57+
Include a list of all the PRs that were involved in implementing the feature.
58+
-->

0 commit comments

Comments
 (0)