Skip to content

Commit 430f025

Browse files
committed
chore: add issue/PR templates, dependabot, contributors, disclaimer
1 parent 0959662 commit 430f025

6 files changed

Lines changed: 147 additions & 2 deletions

File tree

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: Bug Report
2+
description: Report a bug with the modlog publisher
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: category
11+
attributes:
12+
label: Category
13+
options:
14+
- Wiki publishing failure
15+
- Modlog entries missing or incorrect
16+
- Database / deduplication issue
17+
- Docker deployment
18+
- Configuration
19+
- Other
20+
validations:
21+
required: true
22+
- type: dropdown
23+
id: deployment
24+
attributes:
25+
label: Deployment method
26+
options:
27+
- Docker
28+
- Systemd service
29+
- Python native
30+
validations:
31+
required: true
32+
- type: input
33+
id: python-version
34+
attributes:
35+
label: Python version
36+
description: "Output of: python3 --version"
37+
placeholder: "Python 3.12.3"
38+
validations:
39+
required: true
40+
- type: input
41+
id: docker-version
42+
attributes:
43+
label: Docker version (if applicable)
44+
description: "Output of: docker --version. Leave blank if not using Docker."
45+
placeholder: "Docker version 27.5.1"
46+
- type: textarea
47+
id: description
48+
attributes:
49+
label: What happened?
50+
validations:
51+
required: true
52+
- type: textarea
53+
id: expected
54+
attributes:
55+
label: Expected behavior
56+
validations:
57+
required: true
58+
- type: textarea
59+
id: logs
60+
attributes:
61+
label: Log output
62+
description: Relevant log output. Redact subreddit names and tokens if needed.
63+
render: text
64+
validations:
65+
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
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Feature Request
2+
description: Suggest an improvement to the modlog publisher
3+
labels: [enhancement]
4+
body:
5+
- type: dropdown
6+
id: category
7+
attributes:
8+
label: Category
9+
options:
10+
- New modlog action type
11+
- Wiki formatting
12+
- Notification support
13+
- Multi-subreddit feature
14+
- Docker improvement
15+
- Documentation
16+
- Other
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: description
21+
attributes:
22+
label: What would you like?
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: use-case
27+
attributes:
28+
label: Why is this needed?
29+
validations:
30+
required: true

.github/dependabot.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: github-actions
4+
directory: /
5+
schedule:
6+
interval: weekly
7+
commit-message:
8+
prefix: "ci"
9+
- package-ecosystem: pip
10+
directory: /
11+
schedule:
12+
interval: weekly
13+
commit-message:
14+
prefix: "chore"
15+
- package-ecosystem: docker
16+
directory: /
17+
schedule:
18+
interval: weekly
19+
commit-message:
20+
prefix: "chore"

.github/pull_request_template.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## Summary
2+
3+
<!-- What does this PR do? -->
4+
5+
## Changes
6+
7+
- [ ] Modlog parsing / publishing
8+
- [ ] Database / deduplication
9+
- [ ] Docker / deployment
10+
- [ ] CLI / configuration
11+
- [ ] Documentation
12+
13+
## Checklist
14+
15+
- [ ] Tested with at least one subreddit
16+
- [ ] Database migrations handled (if schema changed)
17+
- [ ] Docker image builds successfully
18+
- [ ] No Reddit credentials or tokens in diff
19+
- [ ] README updated (if new config options or changed behavior)

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -414,10 +414,20 @@ Add the bot as a moderator or approved wiki contributor:
414414
| Rate limiting | Increase `--interval` and reduce `--batch-size` |
415415
| Growing DB | Lower `--retention-days` or run cleanup manually |
416416
417-
## License
417+
## Contributors
418+
419+
<a href="https://github.com/baker-scripts/RedditModLog/graphs/contributors">
420+
<img src="https://contrib.rocks/image?repo=baker-scripts/RedditModLog" alt="Contributors" />
421+
</a>
422+
423+
## Disclaimer
418424
419-
MIT or GPLv3 (pick based on your repo)
425+
This software is provided as-is with no warranty. Always review your Reddit API credentials and bot permissions before deployment. The authors are not responsible for any moderation issues or account actions resulting from its use. This project is not affiliated with or endorsed by Reddit.
420426
421427
## Contributing
422428
423429
PRs welcome. Include test runs and changes to CLI/help output.
430+
431+
## License
432+
433+
[GPL-3.0](LICENSE)

0 commit comments

Comments
 (0)