-
-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Objective
Document recommended branch protection rules for the masterror repository to maintain code quality and enforce review processes.
Background
Phase 2.2 from KaiCode 2026 preparation (#205). Branch protection rules cannot be automated via PR but should be documented for maintainers to configure manually.
Tasks
Documentation
- Create
docs/BRANCH_PROTECTION.mdwith recommended settings - Document protection rules for
mainbranch - Document protection rules for release branches
- Add rationale for each rule
Recommended Rules for Main Branch
Required Status Checks:
- Require branches to be up to date before merging
- Require
ci / fmtto pass - Require
ci / clippy (MSRV)to pass - Require
ci / clippy (stable)to pass - Require
ci / test (MSRV)to pass - Require
ci / test (stable)to pass - Require
ci / coverageto pass - Require
ci / denyto pass - Require
ci / auditto pass
Pull Request Requirements:
- Require at least 1 approval
- Dismiss stale reviews on new commits
- Require review from code owners (if CODEOWNERS file exists)
Additional Restrictions:
- Require linear history (no merge commits)
- Do not allow bypassing settings (even for admins)
- Require signed commits (optional, document pros/cons)
Manual Setup Steps
Document step-by-step:
- Navigate to Settings → Branches
- Add branch protection rule for
main - Configure each setting with screenshots
- Verify rules are active
Success Criteria
- Documentation file created with all settings
- Rationale provided for each rule
- Manual setup instructions with screenshots
- Link added to CONTRIBUTING.md
Priority
Medium (manual setup, not blocking)
Related
- Prepare repository for KaiCode 2026 competition #205 KaiCode 2026 preparation
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation