Skip to content

Commit 79d5ddc

Browse files
committed
Rework issue templates
The current templates currently leave all of the help text in the issue if the person forgot to manually remove it. This commit puts the text behind a html comment so that it is absent, as well as reducing the heading size. This also reduces the number of templates from seven to three. The motivation being that a lot of the current templates are unused, and that the distinction between what it makes it a "content" or "technical" feature request is not something that the issue writer necessarily knows about enough to feel confident in saying it's either one.
1 parent 4eff3cc commit 79d5ddc

File tree

7 files changed

+57
-129
lines changed

7 files changed

+57
-129
lines changed

.github/ISSUE_TEMPLATE/design_bug_report.md renamed to .github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,26 @@
11
---
22
name: Design Bug Report
33
about: Found something which looks wrong in the Rust website design?
4+
labels: A-Design, C-Bug
45
---
56

6-
# Design Bug Report
7-
8-
## Page(s) Affected
7+
### Page(s) Affected
8+
<!--
99
Please list the page or pages this bug is present on. Please file one issue
1010
for each bug you find. Only file an issue for a multi-page bug if the bug is
1111
indeed the *same* bug, across the pages.
12+
-->
13+
14+
### What needs to be fixed?
15+
<!--
16+
Tell us what is causing the issue and (if possible) *how* it is causing the
17+
issue. For example, "The lowercase g (in 'Getting') overlaps with the l
18+
(in 'development').".
19+
-->
1220

13-
## What needs to be fixed?
14-
Tell us what is causing the issue and (if possible) *how* it is causing the issue.
15-
For example, "The lowercase g (in 'Getting') overlaps with the l (in 'development').".
21+
### Suggested Improvement
22+
<!--
23+
(optional) Do you have a suggestion for how to fix the problem? Include your
24+
ideas here.
25+
-->
1626

17-
## Suggested Improvement
18-
(optional) Do you have a suggestion for how to fix the problem? Include your ideas
19-
here.
Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,25 @@
11
---
2-
name: Content Bug Report
3-
about: Find a typo? Content out of date? Need a clarification?
2+
name: Incorrect Content
3+
about: Found a typo? Is content out of date? Need a clarification?
4+
labels: A-Content, C-Bug
45
---
56

6-
# Content Bug Report
7+
### What needs to be fixed?
8+
<!--
9+
Tell us what content is causing the issue and *how* it is causing the issue. For
10+
example, "The code sample was confusing because it used advanced Rust features",
11+
or "The call to action on the community page was vague".
12+
-->
713

8-
## Page(s) Affected
14+
### Page(s) Affected
15+
<!--
916
Please list the page or pages this bug is present on. Please file one issue
1017
for each bug you find. Only file an issue for a multi-page bug if the bug is
1118
indeed the *same* bug, across the pages.
19+
-->
1220

13-
## What needs to be fixed?
14-
Tell us what content is causing the issue and *how* it is causing the issue.
15-
For example, "The code sample was confusing because it used advanced Rust features",
16-
or "The call to action on the community page was vague".
17-
18-
## Suggested Improvement
19-
(optional) Do you have a suggestion for how to fix the problem? Include your ideas
20-
here.
21+
### Suggested Improvement
22+
<!--
23+
(optional) Do you have a suggestion for how to fix the problem? Include your
24+
ideas here.
25+
-->

.github/ISSUE_TEMPLATE/content_feature_request.md

Lines changed: 0 additions & 29 deletions
This file was deleted.
Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,42 @@
11
---
2-
name: Design Feature Request
3-
about: Want us to change a design element on the Rust website?
2+
name: Feature Request
3+
about: Would you like to add something to the Rust website?
4+
labels: C-Enhancement
45
---
56

6-
# Design Feature Request
7-
## Summary
7+
### Summary
8+
<!--
89
One paragraph explanation of the design you'd like to see added.
10+
-->
911

10-
## Motivation
11-
Why are we doing this? What use cases does it support? What is the expected
12-
outcome?
12+
### Motivation
13+
<!--
14+
Why are we doing this? What use cases does it support? What is the
15+
expected outcome?
16+
-->
1317

14-
## Drawbacks
18+
### Drawbacks
19+
<!--
1520
Why should we _not_ do this?
21+
-->
1622

17-
## Rationale and alternatives
23+
### Rationale and alternatives
24+
<!--
1825
- Why is this design the best in the space of possible designs?
1926
- What other designs have been considered and what is the rationale for not
2027
choosing them?
2128
- What is the impact of not doing this?
29+
-->
2230

23-
## Maintenance
31+
### Maintenance
32+
<!--
2433
How will this design be maintained? Who will do it?
34+
-->
2535

26-
## Unresolved Questions
36+
### Unresolved Questions
37+
<!--
2738
What related issues do you consider out of scope for this feature that could be
2839
addressed in the future independently of the solution that comes out of this
2940
feature?
41+
-->
42+

.github/ISSUE_TEMPLATE/question.md

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

.github/ISSUE_TEMPLATE/technical_bug_report.md

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

.github/ISSUE_TEMPLATE/technical_feature_request.md

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

0 commit comments

Comments
 (0)