Skip to content

Commit 8bc5ebf

Browse files
committed
Added issue templates
1 parent 8ee0cb9 commit 8bc5ebf

File tree

2 files changed

+140
-0
lines changed

2 files changed

+140
-0
lines changed

Diff for: .github/ISSUE_TEMPLATE/bug-report.yml

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
name: Report a Bug 🐞
2+
description: Help us improve by reporting any issues you encounter.
3+
title: "[BUG] Brief description"
4+
labels: ["status: awaiting triage"]
5+
#assignees: ' '
6+
body:
7+
- type: checkboxes
8+
id: duplicates
9+
attributes:
10+
label: Is this a new issue?
11+
description: Please confirm you've checked that this issue hasn't been reported before.
12+
options:
13+
- label: I have searched "open" and "closed" issues, and this is not a duplicate.
14+
required: true
15+
16+
- type: textarea
17+
id: description
18+
attributes:
19+
label: Bug Description
20+
description: Please provide a clear description of the issue. You can explain it in your own way if preferred.
21+
placeholder: |
22+
Please describe the bug in detail. For example:
23+
- What happened?
24+
- Where did it happen?
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: steps-to-reproduce
30+
attributes:
31+
label: Steps to Reproduce
32+
description: Outline the steps to reproduce the issue. If unsure, just provide any relevant details.
33+
placeholder: |
34+
If you know the steps, you can follow this format:
35+
36+
1. Go to [page or feature]
37+
2. [Describe action taken]
38+
3. [Describe what went wrong]
39+
40+
If unsure, you can explain what you were doing or what you expected to happen.
41+
validations:
42+
required: false
43+
44+
- type: textarea
45+
id: screenshots
46+
attributes:
47+
label: Screenshots
48+
description: Attach any screenshots that might help clarify the issue (if applicable).
49+
placeholder: Upload or drag and drop images here.
50+
validations:
51+
required: false
52+
53+
- type: dropdown
54+
id: assignee
55+
attributes:
56+
label: Would you like to work on this issue?
57+
options:
58+
- "Yes"
59+
- "No"
60+
validations:
61+
required: true
62+
63+
- type: textarea
64+
id: implementation-plan
65+
attributes:
66+
label: Implementation Plan
67+
description: If you selected "Yes" above, please describe how you would approach fixing this issue (Optional).
68+
placeholder: Provide a brief plan or any initial thoughts on fixing the bug.
69+
validations:
70+
required: false
71+
72+
- type: markdown
73+
attributes:
74+
value: |
75+
Thank you for reporting this bug! Please ensure you've filled out all the required sections to help us address the issue as efficiently as possible.

Diff for: .github/ISSUE_TEMPLATE/feature_request.yml

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: Feature Request 💡
2+
description: Have a new idea or feature? Let us know...
3+
title: "[FEATURE] <brief description>"
4+
labels: ["status: awaiting triage"]
5+
6+
body:
7+
- type: checkboxes
8+
id: duplicates
9+
attributes:
10+
label: Is this feature already requested?
11+
description: Ensure this feature hasn't been suggested before.
12+
options:
13+
- label: I have checked "open" and "closed" issues, and this is not a duplicate.
14+
required: true
15+
16+
- type: textarea
17+
id: problem
18+
attributes:
19+
label: Problem or Missing Functionality
20+
description: Briefly describe the problem or the missing functionality that this feature would address.
21+
placeholder: "For ex: I often encounter [specific problem] when using [current feature or lack thereof]. Implementing this feature would improve [specific aspect or workflow] by [explain how it will help]."
22+
validations:
23+
required: false
24+
25+
- type: textarea
26+
id: solution
27+
attributes:
28+
label: Feature Description
29+
description: Describe the feature you're suggesting and how it would solve the problem. Include any relevant details or references.
30+
placeholder: "For ex: I suggest adding [describe the feature] that will [explain its impact]. This feature could be similar to [mention any known implementations or inspirations], which helps by [describe how it benefits the users]."
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: screenshots
36+
attributes:
37+
label: Screenshots
38+
description: Attach any screenshots that might help illustrate the feature or its need (Optional).
39+
placeholder: "If applicable, drag and drop images here or click to upload. Screenshots can help clarify your suggestion by showing the current issue or how the feature might look."
40+
validations:
41+
required: false
42+
43+
- type: dropdown
44+
id: work_on_issue
45+
attributes:
46+
label: Would you like to work on this feature?
47+
options:
48+
- "Yes"
49+
- "No"
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: implementation_plan
55+
attributes:
56+
label: Implementation Plan
57+
description: If you selected "Yes" above, briefly describe how you plan to implement this feature (Optional).
58+
placeholder: "For example: I plan to start by [outline your steps], using [mention any tools, libraries, or frameworks]. This will help ensure the feature is developed efficiently and meets the intended purpose."
59+
validations:
60+
required: false
61+
62+
- type: markdown
63+
attributes:
64+
value: |
65+
Thank you for suggesting a new feature! Please ensure you've filled out all the required sections to help us evaluate your suggestion effectively.

0 commit comments

Comments
 (0)