Skip to content

Commit b9e043b

Browse files
authored
Merge pull request #1174 from DouglasNeuroInformatics/joshunrau-patch-1
docs: update bug report template to include OS and more user-friendly…
2 parents b81fabc + 5a0ceb2 commit b9e043b

File tree

1 file changed

+57
-56
lines changed

1 file changed

+57
-56
lines changed

.github/ISSUE_TEMPLATE/bug.yaml

Lines changed: 57 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,58 @@
1-
name: Bug
2-
description: Report a bug
3-
labels: ["Bug"]
1+
name: Bug Report
2+
description: Report a bug or issue
3+
labels: ['Bug']
44
body:
5-
- type: textarea
6-
attributes:
7-
label: Current Behavior
8-
description: A concise description of what you're experiencing.
9-
placeholder: |
10-
Example: If there are errors in a form and the user changes the language, the error messages are not translated into the new language.
11-
validations:
12-
required: true
13-
- type: textarea
14-
attributes:
15-
label: Expected Behavior
16-
description: A concise description of what you expected to happen.
17-
placeholder: |
18-
Example: If a user changes languages, any error messages in the form should be translated into the new language.
19-
validations:
20-
required: true
21-
- type: dropdown
22-
id: browsers
23-
attributes:
24-
label: Browser
25-
description: What browsers are you seeing the problem on?
26-
multiple: true
27-
options:
28-
- Firefox
29-
- Chrome
30-
- Safari
31-
- Edge
32-
- type: textarea
33-
attributes:
34-
label: Steps To Reproduce
35-
description: Steps to reproduce the behavior.
36-
placeholder: |
37-
Example:
38-
1. Open a form with required fields
39-
2. Attempt to submit the empty form
40-
3. Change the language
41-
validations:
42-
required: false
43-
- type: textarea
44-
attributes:
45-
label: Additional Details
46-
validations:
47-
required: false
48-
- type: dropdown
49-
id: priority
50-
attributes:
51-
label: Priority
52-
options:
53-
- High
54-
- Medium
55-
- Low
56-
validations:
57-
required: true
5+
- type: textarea
6+
attributes:
7+
label: What Happened?
8+
description: Describe the issue you encountered.
9+
placeholder: |
10+
Example: Error messages in a form don't update when switching languages.
11+
validations:
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: What Did You Expect?
16+
description: Describe what you expected to happen instead.
17+
placeholder: |
18+
Example: Error messages should reflect the newly selected language.
19+
validations:
20+
required: true
21+
- type: input
22+
id: os
23+
attributes:
24+
label: Operating System
25+
description: OS and version where the issue occurred (e.g., Windows 11, macOS 14, Ubuntu 22.04).
26+
placeholder: Windows 11, macOS 14.1, Ubuntu 22.04, iOS 17, Android 14
27+
validations:
28+
required: true
29+
- type: dropdown
30+
id: browsers
31+
attributes:
32+
label: Browser (if applicable)
33+
description: Only if this is a browser-related issue.
34+
multiple: true
35+
options:
36+
- Chrome
37+
- Firefox
38+
- Safari
39+
- Edge
40+
validations:
41+
required: false
42+
- type: textarea
43+
attributes:
44+
label: Steps to Reproduce
45+
description: How can we reproduce the issue?
46+
placeholder: |
47+
Example:
48+
1. Open form
49+
2. Submit with errors
50+
3. Change language
51+
validations:
52+
required: false
53+
- type: textarea
54+
attributes:
55+
label: Anything Else?
56+
description: Add logs, screenshots, or other context.
57+
validations:
58+
required: false

0 commit comments

Comments
 (0)