Skip to content

Commit b93d020

Browse files
authored
Merge pull request #15 from Sanjeev-Kumar78/main
Add issue templates for bug reports and feature requests & PR template
2 parents 2473b83 + 2208fc6 commit b93d020

File tree

3 files changed

+77
-0
lines changed

3 files changed

+77
-0
lines changed
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: '[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+
**To Reproduce**
14+
Steps to reproduce the behavior:
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+
**Additional context**
27+
Add any other context about the problem here.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: 🚀 Feature Request
3+
about: Suggest a new idea or enhancement for this project
4+
title: "[Feature]: "
5+
labels: [enhancement]
6+
assignees: ""
7+
---
8+
9+
## ✨ Description
10+
A clear and concise description of the feature you’d like to see.
11+
12+
## 💡 Motivation
13+
Why do you need this feature? What problem does it solve or what improvement does it bring?
14+
15+
## 🧩 Proposed Solution
16+
Describe how you think this could be implemented. Include any technical details, examples, or diagrams if helpful.
17+
18+
## 🔄 Alternatives Considered
19+
List any alternative solutions or features you’ve thought about.
20+
21+
## 🧠 Additional Context
22+
Add any other context, screenshots, or related issues that could help us understand the request better.

.github/pull_request_template.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## Description
2+
3+
**Please include a summary of the change and which issue is fixed. List any dependencies that are required for this change.**
4+
5+
Fixes # (issue) *(only if applicable)*
6+
7+
### Type of Change
8+
9+
Please delete options that are not relevant.
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] This change requires a documentation update
15+
- [ ] Other (please specify):
16+
17+
### Checklist:
18+
19+
- [ ] My code follows the style guidelines of this project
20+
- [ ] I have performed a self-review of my own code
21+
- [ ] I have commented my code, particularly in hard-to-understand areas
22+
- [ ] I have made corresponding changes to the documentation
23+
- [ ] My changes generate no new warnings
24+
- [ ] New and existing unit tests pass locally with my changes
25+
26+
### Screenshots (if applicable)
27+
28+
**Please include any relevant screenshots or images that help explain the changes made.**

0 commit comments

Comments
 (0)