Skip to content

Commit 10cc3c9

Browse files
bakerboy448bakerboy448
committed
chore: add issue/PR templates, dependabot, contributors, disclaimer
1 parent 264b9c5 commit 10cc3c9

6 files changed

Lines changed: 197 additions & 2 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
name: Bug Report
2+
description: Report a bug with a script
3+
labels: [bug]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
**Fill out all required fields.** Incomplete reports will be closed.
9+
- type: dropdown
10+
id: script
11+
attributes:
12+
label: Script
13+
options:
14+
- qui-xseed.sh
15+
- dupe.sh
16+
- merge_folders.py
17+
- backup_config.sh
18+
- f2b-dump.sh
19+
- pmm-update.sh
20+
- qbm-api-trigger.sh
21+
- radarr_dupefinder.sh
22+
- sonarr_dupefinder.sh
23+
- zfsburn.sh
24+
- Other
25+
validations:
26+
required: true
27+
- type: dropdown
28+
id: os
29+
attributes:
30+
label: Operating system
31+
options:
32+
- Linux (Debian/Ubuntu)
33+
- Linux (RHEL/Fedora)
34+
- Linux (other)
35+
- macOS
36+
- Windows (WSL)
37+
validations:
38+
required: true
39+
- type: dropdown
40+
id: deployment
41+
attributes:
42+
label: Deployment method
43+
options:
44+
- Native (script run directly on host)
45+
- Docker (script mounted into container)
46+
validations:
47+
required: true
48+
- type: input
49+
id: bash-version
50+
attributes:
51+
label: Bash version
52+
description: "Output of: bash --version | head -1"
53+
placeholder: "GNU bash, version 5.2.15(1)-release"
54+
validations:
55+
required: true
56+
- type: dropdown
57+
id: starr-app
58+
attributes:
59+
label: Starr app (if applicable)
60+
options:
61+
- Radarr
62+
- Sonarr
63+
- Lidarr
64+
- Readarr
65+
- Prowlarr
66+
- N/A
67+
- type: input
68+
id: starr-version
69+
attributes:
70+
label: Starr app version
71+
description: "System → Status in the Starr app UI. Leave blank if N/A."
72+
placeholder: "5.14.0.9383"
73+
- type: dropdown
74+
id: starr-branch
75+
attributes:
76+
label: Starr app branch
77+
options:
78+
- master / main
79+
- develop
80+
- nightly
81+
- N/A
82+
- type: textarea
83+
id: description
84+
attributes:
85+
label: What happened?
86+
validations:
87+
required: true
88+
- type: textarea
89+
id: steps
90+
attributes:
91+
label: Steps to reproduce
92+
value: |
93+
1.
94+
2.
95+
3.
96+
validations:
97+
required: true
98+
- type: textarea
99+
id: expected
100+
attributes:
101+
label: Expected behavior
102+
validations:
103+
required: true
104+
- type: textarea
105+
id: logs
106+
attributes:
107+
label: Relevant log output
108+
description: Paste the full error output. Redact any secrets.
109+
render: text
110+
validations:
111+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Feature Request
2+
description: Suggest a new script or improvement
3+
labels: [enhancement]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
**Search existing issues before opening a new one.**
9+
- type: dropdown
10+
id: category
11+
attributes:
12+
label: Category
13+
options:
14+
- New script
15+
- Enhancement to existing script
16+
- Documentation
17+
- Other
18+
validations:
19+
required: true
20+
- type: dropdown
21+
id: script
22+
attributes:
23+
label: Related script
24+
options:
25+
- qui-xseed.sh
26+
- dupe.sh
27+
- merge_folders.py
28+
- backup_config.sh
29+
- pmm-update.sh
30+
- qbm-api-trigger.sh
31+
- radarr_dupefinder.sh
32+
- sonarr_dupefinder.sh
33+
- zfsburn.sh
34+
- Other / New
35+
- N/A
36+
validations:
37+
required: true
38+
- type: textarea
39+
id: description
40+
attributes:
41+
label: What would you like?
42+
validations:
43+
required: true
44+
- type: textarea
45+
id: use-case
46+
attributes:
47+
label: Why is this needed?
48+
validations:
49+
required: true

‎.github/dependabot.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: github-actions
4+
directory: /
5+
schedule:
6+
interval: weekly
7+
commit-message:
8+
prefix: "ci"

‎.github/pull_request_template.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
## Summary
2+
3+
<!-- What does this PR do? -->
4+
5+
## Script(s) affected
6+
7+
- [ ] qui-xseed.sh
8+
- [ ] dupe.sh
9+
- [ ] merge_folders.py
10+
- [ ] Other: <!-- specify -->
11+
12+
## Checklist
13+
14+
- [ ] `shellcheck` passes (for .sh files)
15+
- [ ] Tested on target OS
16+
- [ ] `.env.sample` updated (if new env vars added)
17+
- [ ] README updated (if new script or changed behavior)
18+
- [ ] No secrets in diff

‎README.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,10 +139,18 @@ error.
139139
1. Copy `.env.sample` to `.env`.
140140
2. Fill in the required values under "# ZFS Destroy" header.
141141

142-
## Contributions
142+
## Contributors
143+
144+
<a href="https://github.com/baker-scripts/StarrScripts/graphs/contributors">
145+
<img src="https://contrib.rocks/image?repo=baker-scripts/StarrScripts" alt="Contributors" />
146+
</a>
143147

144148
Contributions to improve or expand the scripts collection are welcome. Please refer to the [contribution guidelines](https://github.com/baker-scripts/StarrScripts/blob/main/CONTRIBUTING.md) for more information.
145149

150+
## Disclaimer
151+
152+
These scripts are provided as-is with no warranty. Scripts may delete files, modify configurations, or interact with external APIs. Always review scripts before running and test in a non-production environment first. The authors are not responsible for any data loss or issues resulting from their use.
153+
146154
## License
147155

148-
This project is licensed under the MIT License - see the [LICENSE](https://github.com/baker-scripts/StarrScripts/blob/main/LICENSE) file for details.
156+
[MIT](LICENSE)

0 commit comments

Comments
 (0)