Skip to content

Commit 47c50dc

Browse files
authored
Use forms for issue templates (#933)
This uses the GitHub Form Syntax to make richer issue templates. I took a lot of inspiration from the Dioxus project for the wording of these templates.
1 parent 57c2f02 commit 47c50dc

File tree

4 files changed

+89
-45
lines changed

4 files changed

+89
-45
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

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

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: Bug Report
2+
description: Create a bug report to help us improve.
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Current Behavior
9+
description: A concise description of what you're experiencing.
10+
validations:
11+
required: false
12+
- type: textarea
13+
attributes:
14+
label: Expected Behavior
15+
description: A concise description of what you expected to happen.
16+
validations:
17+
required: false
18+
- type: textarea
19+
attributes:
20+
label: Steps To Reproduce
21+
description: Steps to reproduce the behavior.
22+
placeholder: |
23+
1. In this environment...
24+
1. With this config...
25+
1. Run '...'
26+
1. See error...
27+
validations:
28+
required: false
29+
- type: textarea
30+
attributes:
31+
label: Environment
32+
description: |
33+
examples:
34+
- **OS**: Ubuntu 20.04
35+
- **Architecture**: arm64
36+
- **Version**: v0.8.8
37+
value: |
38+
- OS:
39+
- Architecture:
40+
- Version:
41+
render: markdown
42+
validations:
43+
required: false
44+
- type: textarea
45+
attributes:
46+
label: Anything else?
47+
description: |
48+
Links? References? Anything that will give us more context about the issue you are encountering!
49+
50+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
51+
validations:
52+
required: false
53+
- type: checkboxes
54+
attributes:
55+
label: Questionnaire
56+
description: "If you feel up to the challenge, please check one of the boxes below:"
57+
options:
58+
- label: I'm interested in fixing this myself but don't know where to start
59+
required: false
60+
- label: I would like to fix and I have a solution
61+
required: false
62+
- label: I don't have time to fix this right now, but maybe later
63+
required: false

.github/ISSUE_TEMPLATE/feature-request.md

Lines changed: 0 additions & 14 deletions
This file was deleted.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Feature Request
2+
description: Suggest a new idea for this project.
3+
title: "[Feature]: "
4+
labels: ["enhancement", "triage"]
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Feature description
9+
description: Describe the issue in detail and why we should add it. To help us out, please poke through our issue tracker and make sure it's not a duplicate issue. Ex. As a user, I can do [...]
10+
validations:
11+
required: true
12+
- type: textarea
13+
attributes:
14+
label: Implementation Suggestion
15+
description: If you have any suggestions on how to design this feature, list them here.
16+
validations:
17+
required: false
18+
- type: textarea
19+
attributes:
20+
label: Anything else?
21+
description: |
22+
Links? References? Anything that will give us more context about how to deliver your feature!
23+
24+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
25+
validations:
26+
required: false

0 commit comments

Comments
 (0)