Skip to content

Commit 9b13e33

Browse files
authored
Use bug report and feature request forms for issues (#277)
* Initial bug report * Images can be attached in description * Enclose label in quotes * Wikis are no longer being used * Use footnote to clarify what is up-to-date * Footnotes not supported in checklist * Initial feature request form * Fixup grammar/wording
1 parent a47b0ad commit 9b13e33

File tree

2 files changed

+100
-0
lines changed

2 files changed

+100
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Bug Report
2+
description: File a bug or issue report.
3+
title: '[Bug]: '
4+
labels: ['Type: Bug']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Before reporting, read the [documentation](https://github.com/TagStudioDev/TagStudio/blob/main/doc/index.md) and search existing [issues](https://github.com/TagStudioDev/TagStudio/issues).
10+
Validate that you are using an up-to-date version[^1], your issue might already be fixed!
11+
Questions, guidance, and usage goes in [discussions](https://github.com/TagStudioDev/TagStudio/discussions). Invalid issues will be closed.
12+
13+
[^1]: This can mean latest release, pre-release, or git commit.
14+
- type: checkboxes
15+
attributes:
16+
label: Checklist
17+
description: Make sure you've checked (and actually did) all of the below.
18+
options:
19+
- label: I am using an up-to-date version.
20+
required: true
21+
- label: I have read the [documentation](https://github.com/TagStudioDev/TagStudio/blob/main/doc/index.md).
22+
required: true
23+
- label: I have searched existing [issues](https://github.com/TagStudioDev/TagStudio/issues).
24+
required: true
25+
- type: input
26+
attributes:
27+
label: TagStudio Version
28+
placeholder: Alpha 9.1.0
29+
validations:
30+
required: true
31+
- type: input
32+
attributes:
33+
label: Operating System & Version
34+
placeholder: TagOS 3.14
35+
validations:
36+
required: true
37+
- type: textarea
38+
attributes:
39+
label: Description
40+
description: Clear and concise description of the problem. Attach screenshots if needed, and include any errors you see.
41+
validations:
42+
required: true
43+
- type: textarea
44+
attributes:
45+
label: Expected Behavior
46+
description: Clear and concise description of what you think should happen.
47+
validations:
48+
required: true
49+
- type: textarea
50+
attributes:
51+
label: Steps to Reproduce
52+
description: Minimal steps neded for the problem to occur.
53+
placeholder: |
54+
1.
55+
2.
56+
3.
57+
validations:
58+
required: true
59+
- type: textarea
60+
attributes:
61+
label: Logs
62+
description: Provide any logs, if applicable.
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Feature Request
2+
description: Suggest a new feature.
3+
title: '[Feature Request]: '
4+
labels: ['Type: Enhancement']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Before suggesting, read the [documentation](https://github.com/TagStudioDev/TagStudio/blob/main/doc/index.md) and search existing [issues](https://github.com/TagStudioDev/TagStudio/issues).
10+
Validate that you are using an up-to-date version[^1], your feature might already be implemented!
11+
Questions, guidance, and usage goes in [discussions](https://github.com/TagStudioDev/TagStudio/discussions). Invalid issues will be closed.
12+
13+
[^1]: This can mean latest release, pre-release, or git commit.
14+
- type: checkboxes
15+
attributes:
16+
label: Checklist
17+
description: Make sure you've checked (and actually did) all of the below.
18+
options:
19+
- label: I am using an up-to-date version.
20+
required: true
21+
- label: I have read the [documentation](https://github.com/TagStudioDev/TagStudio/blob/main/doc/index.md).
22+
required: true
23+
- label: I have searched existing [issues](https://github.com/TagStudioDev/TagStudio/issues).
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: Description
28+
description: Clear and concise description of the problem or missing capability. Attach screenshots if needed, and explain your own use case.
29+
validations:
30+
required: true
31+
- type: textarea
32+
attributes:
33+
label: Solution
34+
description: Clear and concise description of what you think should happen.
35+
- type: textarea
36+
attributes:
37+
label: Alternatives
38+
description: Any considered alternative solutions or workarounds. If undesirable, why?

0 commit comments

Comments
 (0)