Skip to content

Commit fbca855

Browse files
committed
Add Issue Templates
1 parent c07a8cd commit fbca855

3 files changed

Lines changed: 110 additions & 0 deletions

File tree

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Bug Report
2+
description: Report an issue with the project.
3+
title: "[BUG] - [short description]"
4+
labels: bug
5+
assignees: ''
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
## Bug Report
12+
13+
Please fill out the following information to help us better understand the issue.
14+
15+
- type: input
16+
attributes:
17+
label: "Bug Description"
18+
description: "Provide a clear and concise description of the bug."
19+
placeholder: "e.g., The app crashes when I try to login."
20+
required: true
21+
22+
- type: textarea
23+
attributes:
24+
label: "Steps to Reproduce"
25+
description: "List the steps to reproduce the behavior."
26+
placeholder: "e.g., 1. Go to login page, 2. Enter username and password, 3. Click login"
27+
required: true
28+
29+
- type: input
30+
attributes:
31+
label: "Expected Behavior"
32+
description: "What did you expect to happen?"
33+
placeholder: "e.g., The app should log me in successfully."
34+
required: true
35+
36+
- type: input
37+
attributes:
38+
label: "Environment"
39+
description: "Please specify the environment where the bug occurs (e.g., OS, browser version)."
40+
placeholder: "e.g., Windows 10, Chrome 92"
41+
required: true
42+
43+
- type: input
44+
attributes:
45+
label: "Version"
46+
description: "What version of the project are you using?"
47+
placeholder: "e.g., 1.0.0"
48+
required: true
49+
50+
- type: textarea
51+
attributes:
52+
label: "Additional Context"
53+
description: "Add any other context or screenshots that might help us understand the issue."
54+
placeholder: "e.g., Logs, stack traces, screenshots"
55+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# .github/ISSUE_TEMPLATE/config.yml
2+
default:
3+
- bug_report
4+
- feature_request
5+
labels:
6+
- "type: bug"
7+
- "type: enhancement"
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Feature Request
2+
description: Suggest a new feature or improvement.
3+
title: "[FEATURE] - [short description]"
4+
labels: enhancement
5+
assignees: ''
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
## Feature Request
12+
13+
Please fill out the following template to help us evaluate your request.
14+
15+
- type: input
16+
attributes:
17+
label: "Feature Description"
18+
description: "Describe the feature or enhancement you would like to see."
19+
placeholder: "e.g., Add dark mode support to the app."
20+
required: true
21+
22+
- type: textarea
23+
attributes:
24+
label: "Use Case"
25+
description: "What problem does this feature solve or how would it improve the project?"
26+
placeholder: "e.g., Dark mode would make the app more comfortable to use at night."
27+
required: true
28+
29+
- type: input
30+
attributes:
31+
label: "Potential Impact"
32+
description: "How would this feature impact the project or the user experience?"
33+
placeholder: "e.g., It would improve accessibility for users with vision impairments."
34+
required: true
35+
36+
- type: input
37+
attributes:
38+
label: "Priority"
39+
description: "How important is this feature? (Low, Medium, High)"
40+
placeholder: "e.g., High"
41+
required: true
42+
43+
- type: textarea
44+
attributes:
45+
label: "Additional Context"
46+
description: "Add any other information that might be helpful."
47+
placeholder: "e.g., Related issues, screenshots, external resources."
48+
required: false

0 commit comments

Comments
 (0)