Skip to content

Commit 0fa5166

Browse files
zachyzissouZach Gonser
andauthored
chore: baseline README governance + CI workflow (#31)
* chore: add baseline README governance and CI workflow * fix markdownlint/security placeholder in SECURITY.md * chore: address baseline copilot review issues --------- Co-authored-by: Zach Gonser <zachgonser@Zachs-Mac-Studio.local>
1 parent 2c164cb commit 0fa5166

File tree

5 files changed

+233
-234
lines changed

5 files changed

+233
-234
lines changed
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: Bug report
3+
about: Report a reproducible bug
4+
title: "[BUG] "
5+
labels: bug
6+
assignees: []
7+
---
8+
9+
## Bug report
10+
11+
**Checklist**
12+
- [ ] I checked existing issues and this is not a duplicate
13+
- [ ] I included repo branch, commit, and repro steps
14+
- [ ] I can reproduce this behavior consistently
15+
16+
### Expected behavior
17+
A clear and concise description of what should happen.
18+
19+
### Actual behavior
20+
What happened instead.
21+
22+
### Environment
23+
- OS:
24+
- Branch/default branch:
25+
- Repo/commit:
26+
- Runtime versions (e.g., Node/Python/.NET):
27+
28+
### Reproduction steps
29+
1.
30+
2.
31+
3.
32+
33+
### Logs / screenshots
34+
Paste relevant logs or upload screenshot files here.
35+
36+
### Additional context
37+
Anything else that helps narrow root cause.

.github/pull_request_template.md

Lines changed: 26 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,26 @@
1-
## Pull Request
2-
3-
### Description
4-
<!-- Provide a clear and concise description of what this PR accomplishes -->
5-
6-
### Type of Change
7-
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
8-
- [ ] ✨ New feature (non-breaking change which adds functionality)
9-
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
10-
- [ ] 📚 Documentation update
11-
- [ ] 🏗️ Refactoring (no functional changes)
12-
- [ ] ⚡ Performance improvement
13-
- [ ] 🧪 Tests
14-
- [ ] 🔧 Chore (maintenance tasks, dependencies, etc.)
15-
16-
### Changes Made
17-
<!-- List the specific changes made in this PR -->
18-
-
19-
-
20-
-
21-
22-
### Testing
23-
- [ ] Tests have been added/updated for these changes
24-
- [ ] All existing tests pass
25-
- [ ] Manual testing completed
26-
27-
### Quality Assurance
28-
- [ ] Code follows the existing style guidelines
29-
- [ ] Self-review of code completed
30-
- [ ] Comments added in hard-to-understand areas
31-
- [ ] Documentation updated (if applicable)
32-
33-
### Deployment
34-
- [ ] Changes are backward compatible
35-
- [ ] No database migrations required
36-
- [ ] Environment variables documented (if added/changed)
37-
- [ ] Docker build tested locally
38-
39-
### Screenshots (if applicable)
40-
<!-- Add screenshots for UI changes -->
41-
42-
### Related Issues
43-
<!-- Link any related issues using keywords: Fixes #123, Closes #456, Relates to #789 -->
44-
45-
### Checklist
46-
- [ ] PR title follows conventional commit format
47-
- [ ] All CI checks are passing
48-
- [ ] Code has been reviewed for security implications
49-
- [ ] Performance impact has been considered
50-
- [ ] Breaking changes are documented
51-
52-
### Notes for Reviewers
53-
<!-- Any additional context or notes for reviewers -->
1+
## Summary
2+
Briefly describe what this PR changes.
3+
4+
## Type of change
5+
- [ ] Docs / README
6+
- [ ] CI / automation
7+
- [ ] Security baseline files
8+
- [ ] Other
9+
10+
## Validation
11+
Please include command outputs and checks run:
12+
- [ ] Lint:
13+
- [ ] Tests:
14+
- [ ] Build:
15+
- [ ] Security scan:
16+
17+
## Related issues
18+
Closes/Fixes/Refs:
19+
20+
## Checklist
21+
- [ ] README updated with required sections (overview, setup, usage, testing, security/privacy, governance)
22+
- [ ] SECURITY.md added/updated (if repo is in scope)
23+
- [ ] Issue template and PR template present
24+
- [ ] CODEOWNERS added/validated (public repos preferred)
25+
- [ ] CI files include this PR and pass locally
26+
- [ ] Branch note added if default branch is `master` or custom

CODEOWNERS

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# CODEOWNERS
2+
# Scope: baseline ownership for review routing
3+
# Replace handles with actual repo owners/maintainers.
4+
5+
# Global owners
6+
* @zachyzissou
7+
8+
# Documentation and automation
9+
/README.md @zachyzissou
10+
/.github/** @zachyzissou
11+
12+
# Source ownership (optional split by stack)
13+
# *.py @python-maintainers
14+
# *.cs @dotnet-maintainers
15+
# *.ts @frontend-maintainers
16+
# *.tsx @frontend-maintainers
17+
# *.astro @web-maintainers
18+
19+
# Infrastructure and security
20+
/.github/workflows/** @zachyzissou
21+
/SECURITY.md @zachyzissou

0 commit comments

Comments
 (0)