Skip to content

Commit 50c41d4

Browse files
chore: add GitHub issue templates, PR template, and Dependabot config
1 parent 9a1e9a2 commit 50c41d4

5 files changed

Lines changed: 107 additions & 0 deletions

File tree

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug to help us improve
4+
title: '[Bug] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
**Describe the Bug**
10+
A clear and concise description of what the bug is.
11+
12+
**To Reproduce**
13+
Steps to reproduce the behavior:
14+
1. Install the tool: `pip install ...`
15+
2. Run command: `...`
16+
3. See error
17+
18+
**Expected Behavior**
19+
A clear and concise description of what you expected to happen.
20+
21+
**Screenshots / Logs**
22+
If applicable, add screenshots or error logs to help explain your problem.
23+
24+
**Environment (please complete):**
25+
- OS: [e.g. macOS 14, Ubuntu 22.04, Windows 11]
26+
- Python version: [e.g. 3.11]
27+
- Tool version: `tool --version`
28+
29+
**Additional Context**
30+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Documentation
4+
url: https://revenueholdings.dev
5+
about: Check the documentation first
6+
- name: Security Concern
7+
url: https://github.com/Coding-Dev-Tools/security
8+
about: Please report security vulnerabilities privately
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: '[Feature] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
**Describe the Solution You'd Like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Describe Alternatives You've Considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Use Case**
19+
How would this feature be used? Who would benefit from it?
20+
21+
**Additional Context**
22+
Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Description
2+
3+
Please include a summary of the change and which issue is fixed.
4+
5+
Fixes # (issue)
6+
7+
## Type of Change
8+
9+
- [ ] Bug fix (non-breaking change fixing an issue)
10+
- [ ] New feature (non-breaking change adding functionality)
11+
- [ ] Breaking change (fix or feature that breaks existing behavior)
12+
- [ ] Documentation update
13+
- [ ] Dependency update
14+
15+
## How Has This Been Tested?
16+
17+
- [ ] `pytest` passes locally
18+
- [ ] Manual test with sample data
19+
20+
## Checklist
21+
22+
- [ ] My code follows the project's style guidelines
23+
- [ ] I have added tests that prove my fix/feature works
24+
- [ ] All new and existing tests pass
25+
- [ ] I have updated the documentation accordingly
26+
- [ ] I have added a CHANGELOG entry

.github/dependabot.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "pip"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"
7+
day: "monday"
8+
open-pull-requests-limit: 10
9+
labels:
10+
- "dependencies"
11+
commit-message:
12+
prefix: "deps"
13+
prefix-development: "deps(dev)"
14+
15+
- package-ecosystem: "github-actions"
16+
directory: "/"
17+
schedule:
18+
interval: "monthly"
19+
open-pull-requests-limit: 5
20+
labels:
21+
- "ci"

0 commit comments

Comments
 (0)