Skip to content

Commit 75b3f83

Browse files
authored
Merge pull request #230 from lucasimi/add-issue-templates
Update issue templates
2 parents e722b5f + 3ce9dd5 commit 75b3f83

File tree

3 files changed

+95
-0
lines changed

3 files changed

+95
-0
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
title: "[Bug]"
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
## 🚨 Description
11+
12+
Describe the bug clearly and concisely. What did you expect to happen, and what actually happened?
13+
14+
## 🤖 Steps to Reproduce
15+
16+
List the exact steps to reproduce the issue. For example:
17+
18+
1. Go to '...'
19+
2. Click on '...'
20+
3. Scroll down to '...'
21+
4. See the error
22+
23+
## 🧩 Expected Behavior
24+
25+
What *should* happen instead?
26+
27+
## 🖥️ Environment
28+
29+
Please provide details about your environment:
30+
31+
- OS:
32+
- Python version:
33+
- Library version:
34+
- Browser (if applicable):
35+
36+
## 📸 Screenshots / Logs (Optional)
37+
38+
Add screenshots or paste error logs here if available.
39+
40+
## ✅ Additional Context (Optional)
41+
42+
Any other relevant context or information about the problem?
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: "[Request]"
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
## 🚀 Feature Request
11+
12+
Describe the feature you'd like. Clearly explain what you want to add or improve.
13+
14+
## 🔍 Motivation
15+
16+
Why is this feature important or useful? Explain what problem it solves or how it improves the user/developer experience.
17+
18+
## 🧠 Algorithm Details (Optional)
19+
20+
Is this related to an algorithm in the package? If so, please provide technical details, such as:
21+
22+
- Which algorithm this affects or extends
23+
- Suggested changes or improvements
24+
- Any relevant theoretical background
25+
- (Optional) Benchmarks or comparisons to support your proposal
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: General Issue
3+
about: For reporting ideas, problems, or tasks that don’t fit other templates
4+
title: "[General]"
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
## 📝 Description
11+
12+
Provide a clear and concise description of the issue or feature request. What is the context, and what problem are we trying to solve?
13+
14+
## 🎯 Goal
15+
16+
Explain the purpose of this issue. Why is it important to address? What value does it bring to users or the project?
17+
18+
## 💡 Proposed Solution
19+
20+
Describe a concrete solution or proposal to address the issue. Include relevant technical details, trade-offs, or alternatives if applicable.
21+
22+
## ✅ Tasks (Optional)
23+
24+
A checklist of actionable steps to complete this issue:
25+
26+
- [ ] Step 1
27+
- [ ] Step 2
28+
- [ ] ...

0 commit comments

Comments
 (0)