8000 Refactor issue markdowm to YAML templates (#491) · rwlarson1/javascript-exercises@7ff69d8 · GitHub
[go: up one dir, main page]
Skip to content

Commit 7ff69d8

Browse files
cakegodcakegod
authored
Refactor issue markdowm to YAML templates (TheOdinProject#491)
1 parent 29dd5a4 commit 7ff69d8

File tree

4 files changed

+157
-0
lines changed

4 files changed

+157
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md renamed to ‎.github/ISSUE_TEMPLATE/archive/bug_report.md

File renamed without changes.

‎.github/ISSUE_TEMPLATE/feature_request.md renamed to ‎.github/ISSUE_TEMPLATE/archive/feature_request.md

File renamed without changes.

‎.github/ISSUE_TEMPLATE/bug_report.yaml

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
name: 🐞 Report a bug
2+
description: Create a report to help us fix something that is not working correctly
3+
title: "Bug: <Brief description of the bug>"
4+
labels: ["Status: Needs Review", "Type: Bug"]
5+
assignees:
6+
- nil
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thank you for contributing your ideas to make our project better!
12+
13+
To help us understand and evaluate your suggestion in a reasonable amount of time, please provide detailed information below.
14+
15+
If you have any questions or are unsure about anything, don't be afraid to ask! The maintainers are here to help.
16+
17+
- type: checkboxes
18+
id: prerequisites
19+
attributes:
20+
label: Prerequisites
21+
description: "Please confirm the following prequisites are met:"
22+
options:
23+
- label: I have thoroughly read and understand [The Odin Project Contributing Guide](https://github.com/TheOdinProject/.github/blob/main/CONTRIBUTING.md)
24+
required: true
25+
- label: I have searched the existing issues to ensure this bug hasn't been reported before (please have a look through our [open issues list](https://github.com/TheOdinProject/javascript-exercises/issues) to make sure)
26+
required: true
27+
- label: "The title of this issue follows the `Bug - location of bug: brief description of bug` format, e.g. `Bug - Exercises: File type incorrect for all test files`"
28+
required: true
29+
- label: (Optional) I am interested in working on this issue and would like to be assigned to it
30+
required: false
31+
32+
- type: textarea
33+
id: bug-description
34+
attributes:
35+
label: Bug Description
36+
description: Clearly describe the bug. Include any screenshots that may help show the bug in action.
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: bug-reproducement
42+
attributes:
43+
label: How to reproduce the bug
44+
description: "List what steps one might need to take in order to reproduce this bug"
45+
placeholder: |
46+
1. Log in
47+
2. Visit a lesson page
48+
3. Click 10000 the complete button
49+
4. The complete button does not update
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: expected-behavior
55+
attributes:
56+
label: Expected Behavior
57+
description: A brief description of what you expected to happen
58+
placeholder: |
59+
1. Log in
60+
2. Visit a lesson page
61+
3. Click the complete button
62+
4. The complete button updates correctly
63+
validations:
64+
required: true
65+
66+
- type: input
67+
id: device
68+
attributes:
69+
label: Device
70+
placeholder: iPhone6
71+
validations:
72+
required: true
73+
74+
- type: input
75+
id: os
76+
attributes:
77+
label: OS
78+
placeholder: iOS
79+
validations:
80+
required: true
81+
82+
- type: input
83+
id: browser
84+
attributes:
85+
label: Browser and its version
86+
placeholder: Chrome 122
87+
validations:
88+
required: true
89+
90+
- type: textarea
91+
id: additional-comments
92+
attributes:
93+
label: (Optional) Additional Comments
94+
description: Provide any extra information that might be helpful, such as links to Discorddiscussions, screenshots, or other relevant details.
95+
placeholder: We ❤️ open source
96+
validations:
97+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.yaml

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: 🌟 Suggest an improvement
2+
description: Suggest a new feature or enhancement
3+
title: "<Location of the improvement>: <Brief description of the improvement>"
4+
labels: ["Status: Needs Review"]
5+
assignees:
6+
- nil
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thank you for contributing your ideas to make our project better!
12+
13+
To help us understand and evaluate your suggestion in a reasonable amount of time, please provide detailed information below.
14+
15+
If you have any questions or are unsure about anything, don't be afraid to ask! The maintainers are here to help.
16+
17+
- type: checkboxes
18+
id: prerequisites
19+
attributes:
20+
label: Prerequisites
21+
description: "Please confirm the following prequisites are met:"
22+
options:
23+
- label: I have thoroughly read and understand [The Odin Project Contributing Guide](https://github.com/TheOdinProject/.github/blob/main/CONTRIBUTING.md)
24+
required: true
25+
- label: I have searched the existing issues to ensure this improvement hasn't been suggested before (please have a look through our [open issues list](https://github.com/TheOdinProject/javascript-exercises/issues) to make sure)
26+
required: true
27+
- label: "The title of this issue follows the `<Location of the improvement>: <Brief description of the improvement>` format, e.g. `Exercises: Add exercise on XYZ`"
28+
required: true
29+
- label: (Optional) I am interested in working on this issue and would like to be assigned to it
30+
required: false
31+
32+
- type: textarea
33+
id: improvement-description
34+
attributes:
35+
label: Improvement Description
36+
description: Clearly describe the proposed feature or enhancement. Explain its purpose, how it would be useful, and what problem(s) it would solve.
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: acceptance-criteria
42+
attributes:
43+
label: Acceptance Criteria
44+
description: List the specific requirements that must be met for this request to be considered complete. Use checkbox items to outline each criterion.
45+
placeholder: |
46+
- [ ] A theme toggle is present on the dashboard
47+
- [ ] Clicking the theme toggle changes between light and dark
48+
- [ ] A user's theme choice persists after leaving the website
49+
validations:
50+
required: true
51+
52+
53+
- type: textarea
54+
id: additional-comments
55+
attributes:
56+
label: (Optional) Additional Comments
57+
description: Provide any extra information that might be helpful, such as links to Discorddiscussions, screenshots, or other relevant details.
58+
placeholder: We ❤️ open source
59+
validations:
60+
required: false

0 commit comments

Comments
 (0)
0