Skip to content

Commit fd95e5d

Browse files
knowlerknowler
committed
Use forms for issue templates
And disallow blank issues. Closes #5 (supersedes it)
1 parent 2fcef22 commit fd95e5d

5 files changed

Lines changed: 150 additions & 65 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

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

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
name: Bug Report
2+
description: Report a bug. Please provide enough information so that we can reproduce the problem.
3+
title: "Bug: "
4+
labels: [bug]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
This form is for reporting technical issues.
11+
If you have a question or you're looking for support, please visit [Roots Discourse](https://discourse.roots.io/).
12+
13+
- type: checkboxes
14+
id: terms
15+
attributes:
16+
options:
17+
- label: I have read the [guidelines for Contributing to Roots Projects](https://github.com/roots/.github/blob/master/CONTRIBUTING.md)
18+
required: true
19+
- label: This request is not a duplicate of an existing issue
20+
required: true
21+
- label: I have read the [docs](https://roots.io/docs/) and followed them (if applicable)
22+
required: true
23+
- label: I have seached the [Roots Discourse](https://discourse.roots.io/) for answers and followed them (if applicable)
24+
required: true
25+
- label: This is not a personal support request that should be posted on the [Roots Discourse](https://discourse.roots.io/) community
26+
required: true
27+
28+
- type: textarea
29+
id: description
30+
attributes:
31+
label: Description
32+
value: |
33+
#### What's wrong?
34+
35+
#### What have you tried?
36+
37+
#### What insights have you gained?
38+
39+
#### Possible solutions
40+
41+
#### Temporary workarounds
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
id: steps-to-reproduce
47+
attributes:
48+
label: Steps To Reproduce
49+
description: |
50+
Non-reproducible issues may be immediately closed as not actionable.
51+
Please provide reproduction steps as detailed as possible.
52+
value: |
53+
1.
54+
1.
55+
1.
56+
validations:
57+
required: true
58+
59+
- type: textarea
60+
id: expected-behavior
61+
attributes:
62+
label: Expected Behavior
63+
placeholder: What did you expect to happen?
64+
validations:
65+
required: true
66+
67+
- type: textarea
68+
id: actual-behavior
69+
attributes:
70+
label: Actual Behavior
71+
placeholder: What actually happens?
72+
validations:
73+
required: true
74+
75+
- type: textarea
76+
id: logs
77+
attributes:
78+
label: Relevant Log Output
79+
description: Please copy and paste any relevant log output.
80+
render: shell
81+
82+
- type: input
83+
id: versions
84+
attributes:
85+
label: Versions
86+
description: You can get this information from referencing `CHANGELOG.md`. If you know, please provide the Git commit SHA. Also, please include the OS and what version of the OS you’re running.
87+
validations:
88+
required: true
89+
90+
- type: markdown
91+
attributes:
92+
value: |
93+
Thanks for taking the time to fill out this bug report!

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
blank_issues_enabled: false
12
contact_links:
23
- name: Roots Discourse
34
url: https://discourse.roots.io

‎.github/ISSUE_TEMPLATE/feature_request.md‎

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

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Feature Request
2+
description: Suggest an idea for this project
3+
title: "Feature Request: "
4+
labels: [feature, enhancement]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
This form is for suggesting an idea for this project.
11+
If you have a question or you're looking for support, please visit [Roots Discourse](https://discourse.roots.io/).
12+
13+
- type: checkboxes
14+
id: terms
15+
attributes:
16+
options:
17+
- label: I have read the [guidelines for Contributing to Roots Projects](https://github.com/roots/.github/blob/master/CONTRIBUTING.md)
18+
required: true
19+
- label: This request is not a duplicate of an existing issue
20+
required: true
21+
- label: This is not a personal support request that should be posted on the [Roots Discourse](https://discourse.roots.io/) community
22+
required: true
23+
24+
- type: textarea
25+
id: summary
26+
attributes:
27+
label: Summary
28+
description: One paragraph explanation of the feature.
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: motivation
34+
attributes:
35+
label: Motivation
36+
value: |
37+
#### Why are we doing this?
38+
39+
#### What use cases does it support?
40+
41+
#### What is the expected outcome?
42+
43+
#### Potential conflicts / foreseeable issues
44+
validations:
45+
required: true
46+
47+
- type: textarea
48+
id: additional-context
49+
attributes:
50+
label: Additional Context
51+
description: Add any other context or screenshots about the feature request here.
52+
53+
- type: markdown
54+
attributes:
55+
value: |
56+
Thanks for taking the time to fill out this feature request form!

0 commit comments

Comments
 (0)