From d658b1bb262cc0e258e80fa66a1383b3cf999dd3 Mon Sep 17 00:00:00 2001
From: Andy <scene@scene.com>
Date: Fri, 24 Oct 2025 01:16:01 +0000
Subject: [PATCH] docs: improve GitHub issue templates for better bug reports
 and feature requests

---
 .github/ISSUE_TEMPLATE/bug_report.md      | 57 ++++++++++++++++++-----
 .github/ISSUE_TEMPLATE/feature_request.md | 42 +++++++++++++++--
 2 files changed, 82 insertions(+), 17 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 28ddae8..4721aee 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,10 +1,9 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
-labels: ''
+title: ""
+labels: ""
 assignees: Sp5rky
-
 ---
 
 **Describe the bug**
@@ -12,21 +11,55 @@ A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
-1. Run command uv run [...]
+
+1. Run command `uv run unshackle [...]`
 2. See error
 
 **Expected behavior**
 A clear and concise description of what you expected to happen.
 
+**System Details**
+
+- OS: [e.g. Windows 11, Ubuntu 22.04, macOS 14]
+- unshackle Version: [e.g. 1.0.1]
+
+**Dependency Versions** (if relevant)
+
+- Shaka-packager: [e.g. 2.6.1]
+- n_m3u8dl-re: [e.g. 0.3.0-beta]
+- aria2c: [e.g. 1.36.0]
+- ffmpeg: [e.g. 6.0]
+- Other: [e.g. ccextractor, subby]
+
+**Logs/Error Output**
+
+<details>
+<summary>Click to expand logs</summary>
+
+```
+Paste relevant error messages or stack traces here
+```
+
+</details>
+
+**Configuration** (if relevant)
+Please describe relevant configuration settings (DO NOT paste credentials or API keys):
+
+- Downloader used: [e.g. requests, aria2c, n_m3u8dl_re]
+- Proxy provider: [e.g. NordVPN, none]
+- Other relevant config options
+
 **Screenshots**
 If applicable, add screenshots to help explain your problem.
 
-**Desktop (please complete the following information):**
- - OS: [e.g. Windows/Unix]
- - Version [e.g. 1.0.1]
- - Shaka-packager Version [e.g. 2.6.1]
- - n_m3u8dl-re Version [e.g. 0.3.0 beta]
- - Any additional software, such as subby/ccextractor/aria2c
-
 **Additional context**
-Add any other context about the problem here, if you're reporting issues with services not running or working, please try to expand on where in your service it breaks but don't include service code (unless you have rights to do so.)
+Add any other context about the problem here.
+
+---
+
+**⚠️ Important:**
+
+- **DO NOT include service-specific implementation code** unless you have explicit rights to share it
+- **DO NOT share credentials, API keys, WVD files, or authentication tokens**
+- For service-specific issues, describe the behavior without revealing proprietary implementation details
+- Focus on core framework issues (downloads, DRM, track handling, CLI, configuration, etc.)
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index d5714f3..2f3d79e 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,21 +1,53 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
-labels: ''
+title: ""
+labels: ""
 assignees: Sp5rky
-
 ---
 
+**Feature Category**
+What area does this feature request relate to?
+
+- [ ] Core framework (downloaders, DRM, track handling)
+- [ ] CLI/commands (new commands or command improvements)
+- [ ] Configuration system
+- [ ] Manifest parsing (DASH, HLS, ISM)
+- [ ] Output/muxing (naming, metadata, tagging)
+- [ ] Proxy system
+- [ ] Key vault system
+- [ ] Documentation
+- [ ] Other (please specify)
+
 **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 [...]
+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.
 
 **Describe alternatives you've considered**
 A clear and concise description of any alternative solutions or features you've considered.
-Other tools like Devine/VT had this function [...]
+
+**Reference implementations** (if applicable)
+Have you seen this feature in other tools?
+
+- [ ] Vinetrimmer
+- [ ] yt-dlp
+- [ ] Other: [please specify]
+
+Please describe how it works there (without sharing proprietary code).
+
+**Use case / Impact**
+
+- How would this feature benefit users?
+- How often would you use this feature?
+- Does this solve a common workflow issue?
 
 **Additional context**
 Add any other context or screenshots about the feature request here.
+
+---
+
+**⚠️ Note:**
+This project focuses on the core framework and tooling. Service-specific feature requests should focus on what the framework should support, not specific service implementations.