Skip to content

Commit a20025f

Browse files
authored
Update issue templates
Bug and Feature request enhancements
1 parent 2bccf8f commit a20025f

File tree

2 files changed

+42
-8
lines changed

2 files changed

+42
-8
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Bug report
33
about: Create a report to help improve Unraid integration
4-
title: ''
4+
title: "[BUG]"
55
labels: bug
66
assignees: ''
77

Lines changed: 41 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,54 @@
11
---
22
name: Feature request
33
about: Suggest an idea for the Unraid integration
4-
title: ''
4+
title: 'Enhancement:'
55
labels: enhancement
66
assignees: ''
77

88
---
99

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 [...]
10+
# :sparkles: **Before You Submit a Feature Request** :sparkles:
1211

13-
**Describe the solution you'd like**
12+
1. **Check Existing Requests**
13+
- Search [open issues](https://github.com/domalab/ha-unraid/labels/enhancement) or [closed issues](https://github.com/domalab/ha-unraid/issues?q=is%3Aclosed+label%3Aenhancement) to see if your idea has already been proposed.
14+
15+
2. **Consider Feasibility & Complexity**
16+
- Keep in mind that this project is primarily developed by a single developer. Please consider if your request is within reasonable scope.
17+
18+
3. **Provide Clear Context**
19+
- Explain the problem you’re trying to solve, and why this feature is helpful or necessary.
20+
21+
---
22+
23+
## **Feature Request Template**
24+
25+
### **Checklist (Required)**
26+
- [ ] I have **searched existing open and closed feature requests** to ensure this is not a duplicate.
27+
- [ ] I understand that feature requests might take time or not be implemented if they are not within project scope.
28+
29+
---
30+
31+
### **Is Your Feature Request Related to a Problem? Please Describe.**
32+
A clear and concise description of what the problem is.
33+
> Example: “I'm always frustrated when...”
34+
35+
---
36+
37+
### **Describe the Solution You’d Like**
1438
A clear and concise description of what you want to happen.
1539

16-
**Use Case or Why Do You Want This?**
40+
---
41+
42+
### **Use Case or Why Do You Want This?**
1743
Describe a specific scenario where this feature would be helpful or explain why you think it's necessary.
1844

19-
**Additional context**
20-
Add any other context or screenshots about the feature request here.
45+
---
46+
47+
### **Additional Details or Considerations (Optional)**
48+
- Include any additional context, potential alternatives, or relevant code snippets.
49+
- If you have any mockups or diagrams, feel free to attach them here.
50+
51+
---
52+
53+
### **Important Note**
54+
Please remember that feature development often involves **time and resources**. As a single developer project, not all feature requests can be fulfilled immediately (or at all). Thank you for understanding and for helping improve this project!

0 commit comments

Comments
 (0)