Skip to content

Commit c382850

Browse files
ManiMatterManiMatter
authored
Merge pull request #357 from lolimmlost/chore/issue-templates
chore: Add GitHub issue templates
2 parents 06adae9 + 0e88557 commit c382850

3 files changed

Lines changed: 199 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
name: 🐛 Bug Report
2+
description: Report a reproducible problem with decluttarr
3+
title: "[Bug] "
4+
labels: ["Bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to file a bug. **Please fill in every required field** — incomplete reports take much longer to resolve and may be closed pending more info.
10+
11+
Before submitting, please confirm:
12+
- You've read the [README](https://github.com/ManiMatter/decluttarr#dependencies--hints--faq), especially the **Dependencies & Hints & FAQ** section
13+
- You've searched [open and closed issues](https://github.com/ManiMatter/decluttarr/issues?q=is%3Aissue) for the same problem
14+
- This is a reproducible bug, not a configuration question (use [Discussions](https://github.com/ManiMatter/decluttarr/discussions) for those)
15+
16+
- type: input
17+
id: version
18+
attributes:
19+
label: Decluttarr commit hash
20+
description: |
21+
The **short commit hash** of the build you're running. `latest` / `dev` tags move too quickly to be useful for reproduction, so please give us the specific commit.
22+
23+
- **Docker users:** grab it from the `short_commit_id` line in the `🛠️ Decluttarr - Settings 🛠️` startup banner (you'll be pasting the full banner in the logs field below)
24+
- **Local Python users:** run `git rev-parse --short HEAD`
25+
placeholder: "e.g. 51b6a4c"
26+
validations:
27+
required: true
28+
29+
- type: dropdown
30+
id: deployment
31+
attributes:
32+
label: Deployment method
33+
options:
34+
- Docker Compose with config.yaml
35+
- Docker Compose with environment variables
36+
- docker run
37+
- Local Python (main.py)
38+
- Other (describe under "Steps to reproduce")
39+
validations:
40+
required: true
41+
42+
- type: dropdown
43+
id: os
44+
attributes:
45+
label: Host OS / architecture
46+
description: |
47+
Where decluttarr is running. Path-related bugs (especially `detect_deletions`) and qBit cookie issues sometimes behave differently on Windows or ARM.
48+
options:
49+
- Linux x86_64 (amd64)
50+
- Linux ARM (arm64 / armv7)
51+
- macOS
52+
- Windows
53+
- Other (describe under "Steps to reproduce")
54+
validations:
55+
required: true
56+
57+
- type: input
58+
id: arr_versions
59+
attributes:
60+
label: "*arr instance versions"
61+
description: Versions of any Sonarr / Radarr / Lidarr / Readarr / Whisparr instances involved in the bug.
62+
placeholder: "e.g. Sonarr 4.0.10, Radarr 5.18.4"
63+
validations:
64+
required: true
65+
66+
- type: input
67+
id: download_client_version
68+
attributes:
69+
label: Download client + version
70+
description: qBittorrent / SABnzbd / etc. and version. Write `n/a` if the bug doesn't involve a download client.
71+
placeholder: "e.g. qBittorrent 5.2.0, or n/a"
72+
validations:
73+
required: true
74+
75+
- type: dropdown
76+
id: test_run
77+
attributes:
78+
label: test_run state
79+
description: |
80+
Removal-related bugs behave very differently with `test_run: true` (no actual removals) vs `false`. Pick the value of `general.test_run` (or `TEST_RUN`) when the bug occurred.
81+
options:
82+
- "false (production — actual removals)"
83+
- "true (test_run mode — no actual removals)"
84+
- Reproduces with both
85+
- N/A (bug doesn't involve removal logic)
86+
validations:
87+
required: true
88+
89+
- type: dropdown
90+
id: frequency
91+
attributes:
92+
label: Reproduction frequency
93+
options:
94+
- Always (every cycle / every time)
95+
- Sometimes (intermittent)
96+
- Once / haven't tried again
97+
- Unknown
98+
validations:
99+
required: true
100+
101+
- type: textarea
102+
id: logs
103+
attributes:
104+
label: Decluttarr startup banner + debug logs
105+
description: |
106+
Please follow these three steps to produce a useful log dump:
107+
108+
1. **Disable jobs not related to your issue** in your config — keeps the logs focused and short
109+
2. **Set `log_level: DEBUG`** (or `VERBOSE` if DEBUG is too noisy)
110+
3. **Restart decluttarr and paste everything from the `🛠️ Decluttarr - Settings 🛠️` startup banner through the cycle that exhibits the bug**
111+
112+
The startup banner already contains `image_tag` / `short_commit_id` and the entire active config (general, jobs, instances, download clients) with API keys masked as `*****`.
113+
114+
**Still sanitize before pasting:** scrub any `?apikey=...` query parameters, `Authorization:` headers, session cookies, and any arr/qBit URLs you'd rather not share. Decluttarr already redacts `X-Api-Key` headers but not query-string keys.
115+
render: shell
116+
validations:
117+
required: true
118+
119+
- type: textarea
120+
id: reproduce
121+
attributes:
122+
label: Steps to reproduce
123+
placeholder: |
124+
1. Start decluttarr with the config above
125+
2. ...
126+
3. ...
127+
validations:
128+
required: true
129+
130+
- type: textarea
131+
id: expected
132+
attributes:
133+
label: Expected behavior
134+
validations:
135+
required: true
136+
137+
- type: textarea
138+
id: actual
139+
attributes:
140+
label: Actual behavior
141+
validations:
142+
required: true
143+
144+
- type: textarea
145+
id: extra
146+
attributes:
147+
label: Anything else?
148+
description: Screenshots, related issues, what you've already tried, hardware/OS details if relevant, etc.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 Questions, usage help, config troubleshooting
4+
url: https://github.com/ManiMatter/decluttarr/discussions
5+
about: |
6+
For general questions, configuration help, or "why is this happening" — please use Discussions instead of opening an issue. The issue tracker is reserved for reproducible bugs and feature requests.
7+
- name: 📚 README & FAQ
8+
url: https://github.com/ManiMatter/decluttarr#dependencies--hints--faq
9+
about: |
10+
Many common problems (qBit cookie issues, multi-instance YAML format, "no valid arr instances" errors, etc.) are covered in the README's Dependencies & Hints & FAQ section. Please check there first.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: ✨ Feature Request
2+
description: Suggest a new feature or enhancement
3+
title: "[Feature] "
4+
labels: ["Feature"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for proposing an improvement! Please make sure there isn't already an [open issue](https://github.com/ManiMatter/decluttarr/issues?q=is%3Aissue+is%3Aopen+label%3AFeature) or [discussion](https://github.com/ManiMatter/decluttarr/discussions) covering the same idea.
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: What problem does this solve?
15+
description: Describe the use case or pain point that the feature would address. What are you trying to accomplish that's currently awkward, manual, or impossible?
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
id: solution
21+
attributes:
22+
label: Proposed solution
23+
description: |
24+
How would this feature work from the user's perspective?
25+
- What does the config look like?
26+
- What does decluttarr do at runtime?
27+
- Are there new env vars / yaml keys / log messages?
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: alternatives
33+
attributes:
34+
label: Alternatives considered
35+
description: Workarounds you've tried, other tools that solve this differently, or alternative implementations you've thought through.
36+
37+
- type: textarea
38+
id: extra
39+
attributes:
40+
label: Anything else?
41+
description: Mockups, references, related issues, or willingness to contribute a PR.

0 commit comments

Comments
 (0)