Skip to content

Commit 65291f3

Browse files
authored
Document protected main workflow (#5)
* Document protected main workflow * Tighten CodeRabbit review policy
1 parent 169cd0a commit 65291f3

File tree

2 files changed

+22
-3
lines changed

2 files changed

+22
-3
lines changed

AGENTS.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,9 @@ Project-specific design and engineering rules live in:
4545
issue-less.
4646
- Keep each PR scoped to one planned task such as `M2-T08`, or one tightly related bundle small
4747
enough to review in one pass.
48-
- Treat CodeRabbit as advisory but mandatory to triage. Apply correctness, safety, recovery, test,
48+
- Treat CodeRabbit as part of the required review path when it is enabled on the repository.
49+
Address every substantive CodeRabbit comment explicitly before merge by either applying the
50+
change or documenting why it is not being applied. Apply correctness, safety, recovery, test,
4951
and docs-alignment feedback by default; document why you reject suggestions that would weaken
5052
determinism, boundedness, or trusted-core discipline.
5153
- After review-driven edits, rerun the relevant validation commands before considering the work

CONTRIBUTING.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,18 +72,22 @@ Add narrower commands too when they strengthen confidence for the specific chang
7272

7373
- human review focuses first on correctness, regressions, missing tests, recovery behavior, and
7474
docs drift
75-
- CodeRabbit is advisory, but every substantial suggestion must be triaged explicitly
75+
- CodeRabbit is part of the review path when enabled on the repository
76+
- every CodeRabbit suggestion or comment that affects the PR must be addressed explicitly before
77+
merge
7678
- apply CodeRabbit suggestions by default when they improve correctness, safety, testing,
7779
observability, or documentation
7880
- reject CodeRabbit suggestions when they add churn without value or weaken determinism,
7981
boundedness, dependency discipline, or trusted-core isolation
8082

81-
Keep a short triage note in the PR description or comments:
83+
Addressing CodeRabbit means one of:
8284

8385
- `applied`
8486
- `not applied`
8587
- short reason when not applied
8688

89+
Do not leave substantive CodeRabbit comments unresolved or silently ignored.
90+
8791
## Merge Policy
8892

8993
Until the repository has more human reviewers, self-merge is acceptable only after:
@@ -94,6 +98,19 @@ Until the repository has more human reviewers, self-merge is acceptable only aft
9498

9599
When the team grows, switch to at least one human approval before merge.
96100

101+
## Repository Guardrails
102+
103+
The GitHub repository is configured so that `main`:
104+
105+
- requires pull requests before merge
106+
- requires the `checks` CI job and uses strict status checks
107+
- requires resolved review conversations
108+
- requires linear history
109+
- disallows force pushes and branch deletion
110+
111+
When enabled on the repository, CodeRabbit is part of the normal review path and its feedback must
112+
be addressed before merge.
113+
97114
## Labels And Milestones
98115

99116
Recommended milestone shape:

0 commit comments

Comments
 (0)