diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-07 10:30:26 +0300 |
|---|---|---|
| committer | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-07 10:30:26 +0300 |
| commit | 09056fc015ebd7e0fc797f29f9510c43591e85da (patch) | |
| tree | 23343790d4d2027cbedc599c469787f29d199b1c | |
| parent | 815179aab30dd3155a7591af75684620a4d47916 (diff) | |
| download | vyos-documentation-09056fc015ebd7e0fc797f29f9510c43591e85da.tar.gz vyos-documentation-09056fc015ebd7e0fc797f29f9510c43591e85da.zip | |
docs(claude-md): document PR review bot workflow
Add a "PR review workflow" section after CI describing how Copilot
and CodeRabbit are used on this repo:
- Copilot is opt-in (`@copilot review`) and works on drafts.
- CodeRabbit auto-runs when a PR flips to ready-for-review and does
not review drafts.
- Convention: draft → iterate with Copilot → flip ready → iterate
CodeRabbit → human review.
- Every review thread needs an explicit reply before resolving.
This matches the cross-repo workflow in `vyos-github` org rules and
makes the convention discoverable for new contributors landing on the
repo without prior context.
\xf0\x9f\xa4\x96 Generated by [robots](https://vyos.io)
| -rw-r--r-- | CLAUDE.md | 17 |
1 files changed, 17 insertions, 0 deletions
@@ -184,3 +184,20 @@ A PR that both adds and removes TODOs is not contradictory; intent matters. - **Sphinx build** — runs on Read the Docs for every PR; preview URL appears as a check. - **CLA check** — contributors must sign the VyOS CLA before merge. - **Conflict check** — fails the PR if it doesn't merge cleanly into base. + +## PR review workflow + +Two automated reviewers run on PRs in this repo: + +- **Copilot** (`@copilot`) — opt-in, works on draft PRs. Trigger by commenting `@copilot review` on the PR. +- **CodeRabbit** (`@coderabbitai`) — auto-runs when a PR flips to ready-for-review. Does **not** review drafts. Re-trigger with `@coderabbitai review` after each round of fixes. + +Convention: + +1. Open the PR as a **draft** (`gh pr create --draft`). +2. Iterate while draft: comment `@copilot review` per round of commits until Copilot is silent. +3. Flip to ready (`gh pr ready <num>`). CodeRabbit picks it up automatically. +4. Address CodeRabbit threads, push commits, re-comment `@coderabbitai review` if you want another pass. +5. When both bots are silent, the PR is ready for human review. + +Every review thread (Copilot or CodeRabbit) needs an **explicit reply** before resolving — fix in code with the commit SHA, or push back with technical reasoning. Never silently resolve. |