Skip to content

Commit d5883a4

Browse files
authored
chore: add issue template (#48)
Resolved: #18
1 parent 5468879 commit d5883a4

File tree

2 files changed

+154
-0
lines changed

2 files changed

+154
-0
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
name: Bug Report
2+
description: Submit a bug report for a frontend UI library.
3+
title: "[Bug] Brief Title of the Issue"
4+
body:
5+
- type: dropdown
6+
id: will-contribute
7+
attributes:
8+
label: Willing to Contribute to the Fix?
9+
description: If you're planning to assist in fixing this issue, please let us know so we can avoid duplicating efforts.
10+
options:
11+
- "Yes"
12+
- "No"
13+
- Maybe
14+
default: 0
15+
validations:
16+
required: true
17+
- type: markdown
18+
attributes:
19+
value: |
20+
Thank you for taking the time to submit this UI bug report! Please provide as much detail as possible to help us resolve the issue quickly.
21+
- type: input
22+
id: contact
23+
attributes:
24+
label: Contact Information
25+
description: How can we reach you if we need more information?
26+
placeholder: E.g., [email protected]
27+
validations:
28+
required: false
29+
- type: textarea
30+
id: what-happened
31+
attributes:
32+
label: What Happened?
33+
description: What UI issue did you encounter? Please describe the specific behavior.
34+
placeholder: E.g., Button unresponsive, text overflow, etc.
35+
value: "UI issue occurred!"
36+
validations:
37+
required: true
38+
- type: textarea
39+
id: expected-behavior
40+
attributes:
41+
label: Expected Behavior
42+
description: How should the UI element appear or behave?
43+
placeholder: Please describe the expected UI behavior.
44+
value: "The button should be clickable, the text should fit the container."
45+
validations:
46+
required: true
47+
- type: dropdown
48+
id: browsers
49+
attributes:
50+
label: In which browsers did you observe this issue?
51+
multiple: true
52+
options:
53+
- Firefox
54+
- Chrome
55+
- Safari
56+
- Microsoft Edge
57+
description: Please select the browsers where the issue occurred.
58+
validations:
59+
required: false
60+
- type: textarea
61+
id: steps-to-reproduce
62+
attributes:
63+
label: Steps to Reproduce
64+
description: Please provide the specific steps to reproduce this issue.
65+
placeholder: E.g., 1. Click the button 2. Error message appears
66+
validations:
67+
required: true
68+
- type: textarea
69+
id: logs
70+
attributes:
71+
label: Browser Console Logs (if any)
72+
description: If you saw any errors in the browser console, please paste the relevant logs here.
73+
placeholder: Please copy and paste the related console logs.
74+
render: shell
75+
- type: checkboxes
76+
id: terms
77+
attributes:
78+
label: Code of Conduct
79+
description: By submitting this issue, you agree to follow the project's code of conduct.
80+
options:
81+
- label: I agree to follow the project's code of conduct
82+
required: true

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
name: Feature Request
2+
description: Submit a feature request
3+
title: "[Feature] Brief Title of the Feature"
4+
body:
5+
- type: dropdown
6+
id: will-contribute
7+
attributes:
8+
label: Willing to Help Develop?
9+
description: If you plan to help with the development of this feature, please let us know so we can coordinate efforts.
10+
options:
11+
- "No"
12+
- "Yes"
13+
- Maybe
14+
default: 0
15+
validations:
16+
required: true
17+
- type: markdown
18+
attributes:
19+
value: |
20+
Thank you for submitting this feature request! Please provide as much detail as possible to help us understand your needs.
21+
- type: input
22+
id: contact
23+
attributes:
24+
label: Contact Information
25+
description: How can we contact you if we need more information?
26+
placeholder: E.g., [email protected]
27+
validations:
28+
required: false
29+
- type: textarea
30+
id: feature-description
31+
attributes:
32+
label: Feature Description
33+
description: Please describe the feature you would like to request or the improvements you suggest.
34+
placeholder: E.g., Would like to add support for a specific API integration or a new settings option.
35+
value: "I would like to add a new feature..."
36+
validations:
37+
required: true
38+
- type: textarea
39+
id: use-case
40+
attributes:
41+
label: Use Case
42+
description: Please provide context or scenarios where this feature would be used, helping us understand its need.
43+
placeholder: E.g., A feature for automating reports or enhancing accessibility.
44+
validations:
45+
required: true
46+
- type: dropdown
47+
id: priority
48+
attributes:
49+
label: Feature Priority
50+
options:
51+
- High
52+
- Medium
53+
- Low
54+
description: Please specify the priority for this feature.
55+
validations:
56+
required: true
57+
- type: textarea
58+
id: additional-info
59+
attributes:
60+
label: Additional Information
61+
description: If you have any extra details or resources, please provide them here.
62+
placeholder: Provide related links or documents.
63+
validations:
64+
required: false
65+
- type: checkboxes
66+
id: terms
67+
attributes:
68+
label: Code of Conduct
69+
description: By submitting this feature request, you agree to follow the project's code of conduct.
70+
options:
71+
- label: I agree to follow the project's code of conduct
72+
required: true

0 commit comments

Comments
 (0)