Skip to content

Commit bf8c39e

Browse files
authored
feat: add GitHub templates (CODEOWNERS, PR template, issue templates) (#14)
* feat: add GitHub templates (CODEOWNERS, PR template, issue templates) - CODEOWNERS for automatic reviewer assignment - Pull request template with checklist - Issue templates for bugs and feature requests Stu Mason + AI <me@stumason.dev> * feat: enhance templates based on code review suggestions - Add environment/version info field to bug report template - Add logs/error messages field with shell rendering to bug report - Add Related Issues section to PR template - Add Breaking Changes section to PR template Addresses suggestions from Claude Code review on PR #14. Stu Mason + AI <me@stumason.dev>
1 parent 3390e22 commit bf8c39e

File tree

5 files changed

+88
-0
lines changed

5 files changed

+88
-0
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @StuMason
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Bug Report
2+
description: Report something that's broken
3+
labels: ["bug"]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: What happened?
9+
validations:
10+
required: true
11+
- type: textarea
12+
id: steps
13+
attributes:
14+
label: Steps to reproduce
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: expected
19+
attributes:
20+
label: Expected behaviour
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: environment
25+
attributes:
26+
label: Environment
27+
description: Include relevant version info
28+
placeholder: |
29+
- Docker version:
30+
- Deployment mode (docker-compose/standalone):
31+
- OS:
32+
- type: textarea
33+
id: logs
34+
attributes:
35+
label: Logs / Error messages
36+
description: Include any relevant logs or error messages
37+
render: shell
38+
- type: textarea
39+
id: context
40+
attributes:
41+
label: Additional context

.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: true
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement
3+
labels: ["enhancement"]
4+
body:
5+
- type: textarea
6+
id: problem
7+
attributes:
8+
label: Problem or motivation
9+
validations:
10+
required: true
11+
- type: textarea
12+
id: solution
13+
attributes:
14+
label: Proposed solution
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: alternatives
19+
attributes:
20+
label: Alternatives considered

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
## Summary
2+
3+
4+
## Related Issues
5+
6+
Closes #
7+
8+
## Changes
9+
10+
-
11+
12+
## Breaking Changes
13+
14+
- [ ] No breaking changes
15+
- [ ] Breaking changes (describe below)
16+
17+
## Test plan
18+
19+
- [ ] Tests added/updated
20+
- [ ] Manually tested locally
21+
22+
## Checklist
23+
24+
- [ ] Code follows project conventions
25+
- [ ] Documentation updated if needed

0 commit comments

Comments
 (0)