Skip to content

Commit 8d533ce

Browse files
author
Ricardo Sanchez
committed
ci(gov): add CODEOWNERS, PR template, and branch protection guidance
Introduces CODEOWNERS for mandatory review, standardized pull_request_template, and CONTRIBUTING updates describing required status checks and branch protection settings.
1 parent 76e9cf6 commit 8d533ce

File tree

3 files changed

+42
-0
lines changed

3 files changed

+42
-0
lines changed

.github/CODEOWNERS

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Automatically require review from repository owner for any change
2+
* @ricardodsanchez
3+
4+
# Generator and data changes always need review
5+
_data/** @ricardodsanchez
6+
scripts/generate_readme.rb @ricardodsanchez

.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+
Describe the change and motivation.
4+
5+
## Checklist
6+
7+
- [ ] Updated `_data/resources.yml` (if adding/updating resources)
8+
- [ ] Ran `ruby scripts/generate_readme.rb` locally
9+
- [ ] README diff is committed
10+
- [ ] Link check passes (or false positives explained)
11+
- [ ] Status choices align with taxonomy
12+
- [ ] No direct edits to generated table formatting
13+
14+
## Type of Change
15+
16+
- [ ] feat
17+
- [ ] fix
18+
- [ ] docs
19+
- [ ] chore
20+
- [ ] refactor
21+
- [ ] ci
22+
23+
## Notes for Reviewers
24+
25+
(Optional) Anything surprising, rationale for status changes, or link exceptions.

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,17 @@ Two GitHub Actions support quality:
7878
1. `Generate README` workflow ensures `README.md` matches `_data/resources.yml`. If it fails, run the generator and recommit.
7979
2. `Link Check` (weekly + on relevant PRs) validates external URLs. Fix or replace dead links when flagged.
8080

81+
### Branch Protection & PR Requirements
82+
83+
The `main` branch should be protected (enable in GitHub Settings > Branches):
84+
85+
- Require pull request reviews before merging (CODEOWNERS enforces an owner review)
86+
- Require status checks to pass: `Generate README`, `Link Check`
87+
- Dismiss stale approvals on new commits (optional but recommended)
88+
- Restrict pushes so direct commits to `main` are disallowed
89+
90+
After enabling protection, all changes must flow through PRs. If you see a bypass message in push output, protections are not fully configured yet.
91+
8192
### Optional Local Git Hook
8293

8394
To automatically regenerate the README when editing `_data/resources.yml` you can enable the provided pre-commit hook:

0 commit comments

Comments
 (0)