Skip to content

Commit 9fae2bb

Browse files
authored
Update issue templates
Added two templates to assist contributors when creating issues: - One for reporting issues, errors in existing implementations. - Second for proposing new implementations or enhancements to existing ones.
1 parent a24e2b8 commit 9fae2bb

File tree

2 files changed

+47
-0
lines changed

2 files changed

+47
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

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: ''
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: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: New/Optimize implementation
3+
about: Propose an enhancement or a new algorithm implementation.
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Description**
11+
Provide a clear and concise description of the issue.
12+
13+
For new implementation:
14+
- Name and problem statement for the algorithm.
15+
16+
For enhancement:
17+
- Specify what needs to be changed and why. For example:
18+
- Adding tests.
19+
- Optimizing logic.
20+
- Refactoring file and folders for better structure.

0 commit comments

Comments
 (0)