Skip to content

Commit 0008f68

Browse files
committed
Use forms for issue templates.
1 parent c7957a7 commit 0008f68

File tree

6 files changed

+120
-79
lines changed

6 files changed

+120
-79
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

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

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Bug Report
2+
description: Create a report to help us improve
3+
labels: ["C-bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: Thanks for filing a 🐛 bug report 😄!
8+
- type: textarea
9+
id: problem
10+
attributes:
11+
label: Problem
12+
description: >
13+
Please provide a clear and concise description of what the bug is,
14+
including what currently happens and what you expected to happen.
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: steps
19+
attributes:
20+
label: Steps
21+
description: Please list the steps to reproduce the bug.
22+
placeholder: |
23+
1.
24+
2.
25+
3.
26+
- type: textarea
27+
id: possible-solutions
28+
attributes:
29+
label: Possible Solution(s)
30+
description: >
31+
Not obligatory, but suggest a fix/reason for the bug,
32+
or ideas how to implement the addition or change.
33+
- type: textarea
34+
id: notes
35+
attributes:
36+
label: Notes
37+
description: Provide any additional notes that might be helpful.
38+
- type: textarea
39+
id: version
40+
attributes:
41+
label: Version
42+
description: Please paste the output of running `cargo version --verbose`.
43+
render: text

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 16 deletions
This file was deleted.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Feature Request
2+
description: Suggest an idea for enhancing Cargo
3+
labels: ["C-feature-request"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: Thanks for filing a 🙋 feature request 😄!
8+
- type: textarea
9+
id: problem
10+
attributes:
11+
label: Problem
12+
description: >
13+
Please provide a clear description of your use case and the problem
14+
this feature request is trying to solve.
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: solution
19+
attributes:
20+
label: Proposed Solution
21+
description: >
22+
Please provide a clear and concise description of what you want to happen.
23+
- type: textarea
24+
id: notes
25+
attributes:
26+
label: Notes
27+
description: Provide any additional context or information that might be helpful.

.github/ISSUE_TEMPLATE/tracking_issue.md

Lines changed: 0 additions & 35 deletions
This file was deleted.
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Tracking Issue
2+
description: A tracking issue for an accepted feature or RFC in Cargo.
3+
title: "Tracking Issue for _FEATURE_NAME_"
4+
labels: ["C-tracking-issue"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
Thank you for creating a tracking issue! Tracking issues are for tracking an
10+
accepted feature or RFC from implementation to stabilization. Please do not
11+
file a tracking issue until the feature or RFC has been approved.
12+
- type: textarea
13+
id: summary
14+
attributes:
15+
label: Summary
16+
description: Please provide a very brief summary of the feature.
17+
value: |
18+
RFC: [#NNNN](https://github.com/rust-lang/rfcs/pull/NNNN) <!-- If this is an RFC -->
19+
Original issue: #NNNN <!-- if there is a related issue that spawned this feature -->
20+
Implementation: #NNNN <!-- link to the PR that implemented this feature if applicable -->
21+
Documentation: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#my-feature
22+
23+
Please enter a short, one-sentence description here.
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: unresolved
28+
attributes:
29+
label: Unresolved Issues
30+
description: List issues that have not yet been resolved.
31+
placeholder: |
32+
* [ ] Make a list of any known implementation or design issues.
33+
- type: textarea
34+
id: future
35+
attributes:
36+
label: Future Extensions
37+
description: >
38+
An optional section where you can mention where the feature may be
39+
extended in the future, but is explicitly not intended to
40+
address.
41+
- type: textarea
42+
id: about
43+
attributes:
44+
label: About tracking issues
45+
description: Please include this notice in the issue.
46+
value: |
47+
Tracking issues are used to record the overall progress of implementation.
48+
They are also used as hubs connecting to other relevant issues, e.g., bugs or open design questions.
49+
A tracking issue is however *not* meant for large scale discussion, questions, or bug reports about a feature.
50+
Instead, open a dedicated issue for the specific matter and add the relevant feature gate label.

0 commit comments

Comments
 (0)