Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
Bug and Feature request enhancements
  • Loading branch information
domalab authored Jan 9, 2025
1 parent 2bccf8f commit a20025f
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Bug report
about: Create a report to help improve Unraid integration
title: ''
title: "[BUG]"
labels: bug
assignees: ''

Expand Down
48 changes: 41 additions & 7 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,54 @@
---
name: Feature request
about: Suggest an idea for the Unraid integration
title: ''
title: 'Enhancement:'
labels: enhancement
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
# :sparkles: **Before You Submit a Feature Request** :sparkles:

**Describe the solution you'd like**
1. **Check Existing Requests**
- 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.

2. **Consider Feasibility & Complexity**
- Keep in mind that this project is primarily developed by a single developer. Please consider if your request is within reasonable scope.

3. **Provide Clear Context**
- Explain the problem you’re trying to solve, and why this feature is helpful or necessary.

---

## **Feature Request Template**

### **Checklist (Required)**
- [ ] I have **searched existing open and closed feature requests** to ensure this is not a duplicate.
- [ ] I understand that feature requests might take time or not be implemented if they are not within project scope.

---

### **Is Your Feature Request Related to a Problem? Please Describe.**
A clear and concise description of what the problem is.
> Example: “I'm always frustrated when...”
---

### **Describe the Solution You’d Like**
A clear and concise description of what you want to happen.

**Use Case or Why Do You Want This?**
---

### **Use Case or Why Do You Want This?**
Describe a specific scenario where this feature would be helpful or explain why you think it's necessary.

**Additional context**
Add any other context or screenshots about the feature request here.
---

### **Additional Details or Considerations (Optional)**
- Include any additional context, potential alternatives, or relevant code snippets.
- If you have any mockups or diagrams, feel free to attach them here.

---

### **Important Note**
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 comments on commit a20025f

Please sign in to comment.