Skip to content

Commit f09ebdc

Browse files
authored
Merge pull request #99 from vedansh-5/githubTemplates
[Feature] Updated Issue and PR templates
2 parents 865ebf8 + 012463d commit f09ebdc

File tree

2 files changed

+56
-11
lines changed

2 files changed

+56
-11
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,34 @@
1-
**Actual Behaviour**
1+
---
2+
name: Bug Report / Feature Request
3+
about: Report a bug or request a new feature
4+
title: '[Bug/Feature]: <short description>'
5+
labels: ['needs triage']
6+
assignees: ''
7+
---
28

3-
Please state here what is currently happening.
9+
### 🔍 Actual Behaviour
410

5-
**Expected Behaviour**
11+
What is currently happening?
612

7-
State here what the feature should enable the user to do.
13+
### ✅ Expected Behaviour
814

9-
**Screenshots of the issue**
15+
What should ideally happen?
1016

11-
Where-ever possible attach a screenshot of the issue.
17+
### 📸 Screenshots
1218

13-
**Would you like to work on the issue?**
19+
If applicable, add screenshots to help explain the issue.
1420

15-
Please let us know if you can work on it or the issue should be assigned to someone else.
21+
### 🧪 Steps to Reproduce (for bugs)
22+
23+
1. Go to '...'
24+
2. Click on '...'
25+
3. Scroll down to '...'
26+
4. See the error
27+
28+
### 💡 Possible Solution
29+
30+
(Optional) Suggest a fix or reason for the bug.
31+
32+
### 🙋‍♂️ Would You Like to Work on It?
33+
34+
Yes / No

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,31 @@
1-
Fixes issue #[Add issue number here. If you do not solve the issue entirely, please change the message e.g. "First steps for issues #IssueNumber]
1+
### 📌 Fixes
22

3-
Changes: [Add here what changes were made in this issue and if possible provide links.]
3+
Fixes #<issue-number> (Use "Fixes", "Closes", or "Resolves" for automatic closing)
44

5-
Screenshots for the change:
5+
---
6+
7+
### 📝 Summary of Changes
8+
9+
- Short description of what was changed
10+
- Include links to related issues/discussions if any
11+
12+
---
13+
14+
### 📸 Screenshots / Demo (if UI-related)
15+
16+
_Add screenshots, video, or link to deployed preview if applicable_
17+
18+
---
19+
20+
### ✅ Checklist
21+
22+
- [ ] I’ve tested my changes locally
23+
- [ ] I’ve added tests (if applicable)
24+
- [ ] I’ve updated documentation (if applicable)
25+
- [ ] My code follows the project’s code style guidelines
26+
27+
---
28+
29+
### 👀 Reviewer Notes
30+
31+
_Add any special notes for the reviewer here_

0 commit comments

Comments
 (0)