Skip to content

Commit 271da1a

Browse files
committed
ADD: Issue and Pull Request Templates
1 parent 181d707 commit 271da1a

File tree

9 files changed

+150
-1
lines changed

9 files changed

+150
-1
lines changed
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "[BUG] Brief description of the bug"
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**Steps to reproduce**
14+
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Environment (please complete the following information):**
27+
28+
- OS: [e.g. Windows, macOS, Linux]
29+
- Browser [e.g. Chrome, Firefox, Safari]
30+
31+
**Additional context**
32+
Add any other context about the problem here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "[FEATURE] Brief description of the new feature"
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: New UI Snippet
3+
about: Suggest a new UI snippet for the project
4+
title: "[UI] Brief description of the new UI snippet"
5+
labels: enhancement, UI
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the UI snippet**
11+
A clear and concise description of the UI snippet you want to add.
12+
13+
**Why is this UI snippet useful?**
14+
Explain the benefits and use cases for this UI snippet.
15+
16+
**Design or mockup**
17+
If possible, provide a design or mockup of the UI snippet.
18+
19+
**Additional context**
20+
Add any other context or information about the UI snippet here.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Other Issue
3+
about: For issues that don't fit the other categories
4+
title: "[OTHER] Brief description of the issue"
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the issue**
11+
A clear and concise description of the issue.
12+
13+
**Additional context**
14+
Add any other context or information about the issue here.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
**Describe the bug fix**
2+
A clear and concise description of the bug fix and the issue it resolves.
3+
4+
**Related issue(s)**
5+
If applicable, link to the related issue(s) in the repository.
6+
7+
**Steps to reproduce the original bug**
8+
9+
1. Go to '...'
10+
2. Click on '....'
11+
3. Scroll down to '....'
12+
4. See error
13+
14+
**Testing the bug fix**
15+
Provide steps to test the bug fix and ensure it resolves the issue.
16+
17+
**Additional context**
18+
Add any other context or information about the bug fix here.
19+
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
**Describe the new feature**
2+
A clear and concise description of the new feature you want to add.
3+
4+
**Why is this feature useful?**
5+
Explain the benefits and use cases for this feature.
6+
7+
**Implementation details**
8+
Provide a high-level overview of how this feature can be implemented, including any dependencies or requirements.
9+
10+
**Testing the new feature**
11+
Provide steps to test the new feature and ensure it works as expected.
12+
13+
**Additional context**
14+
Add any other context or information about the feature here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
**UI Snippet Name**
2+
Provide a name for the new UI snippet.
3+
4+
**Describe the UI Snippet**
5+
A clear and concise description of the UI snippet and its purpose.
6+
7+
**Related issue(s)**
8+
If applicable, link to the related issue(s) in the repository.
9+
10+
**Design and Implementation**
11+
Provide details about the design and implementation of the UI snippet, including any dependencies, libraries, or frameworks used.
12+
13+
**Testing the UI Snippet**
14+
Provide steps to test the UI snippet and ensure it works as expected.
15+
16+
**Screenshots**
17+
If applicable, add screenshots to help explain the UI snippet.
18+
19+
**Additional context**
20+
Add any other context or information about the UI snippet here.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
**Describe the change**
2+
A clear and concise description of the change you are proposing.
3+
4+
**Reason for the change**
5+
Explain why this change is necessary or beneficial.
6+
7+
**Testing the change**
8+
Provide steps to test the change and ensure it works as expected.
9+
10+
**Additional context**
11+
Add any other context or information about the change here.

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
.github
21

32
.env
43
.env.example

0 commit comments

Comments
 (0)