Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,8 @@ to change. Also read [server/AGENTS.md](server/AGENTS.md) and [src/AGENTS.md](sr
the Release run is done.
- Required checks: Fast checks, Integration and browser, Native Windows install. Resolve review
threads before merging (branch protection does not enforce it).
- Run `bun run check fast` before every push, and push a PR's commits together: each push to a
PR cancels its CI run in progress and starts every job again.
- CodeRabbit's reviews are rationed per PR author, and agents open their PRs as one account:
opening a PR, a push and each `@coderabbitai review` spend one, and past about 80 in a week
one comes back per hour. Open verified work ready for review, not as a draft: the merge pass
Expand All @@ -92,9 +94,15 @@ to change. Also read [server/AGENTS.md](server/AGENTS.md) and [src/AGENTS.md](sr
only after a commit that changes behaviour in `server/`, `src/` or `shared/`, an HTTP/WS
contract or a workflow. A rebase, changelog fragment, docs, comment or test-only commit gets
none.
- A rate-limited review still shows a passing CodeRabbit check; its "Review limit reached"
comment means no review ran. A PR touching `--takeover`, observe permissions, queued input,
authentication, an HTTP/WS contract or a workflow waits for a real review. Any other PR says
in a comment that CodeRabbit did not review it, and merges on its checks and the maintainer.
- A rate-limited or skipped review still shows a passing CodeRabbit check; its "Review limit
reached" or "Review skipped" comment means no review ran. CodeRabbit skips a PR of more than
150 files, so a PR that needs a review stays under that.
- A PR touching `--takeover`, observe permissions, queued input, authentication, an HTTP/WS
contract or a workflow waits for a real review. When CodeRabbit skips it, a code-review agent's
review stands in: its findings and how each was resolved go in a PR comment before the merge.
- A move-only PR (files moved or split, imports updated, no behaviour change) does not wait for
CodeRabbit: it merges on its checks once its diff shows only moved code and import paths
(`git diff --color-moved origin/main...HEAD`). Every PR merged without a CodeRabbit review
says so in a comment, and any other PR merges on its checks and the maintainer.
- Changelog entries go in `changelog.d/` fragments ([format](changelog.d/README.md)), not
CHANGELOG.md; only a release folds them in.
6 changes: 4 additions & 2 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -757,8 +757,10 @@ administrators. Branch protection does not require branches to be up to date bef
does not enforce resolved review threads; resolve every review thread before merging anyway, as a
practice. Force pushes and branch deletion are disabled. Human approvals are optional for this maintainer-led
project; external contributions still need maintainer review. CodeRabbit is advisory, not a required
check. It reviews a pull request once when it opens and not on later pushes;
comment `@coderabbitai review` on the final head before merging and wait for it.
check. It reviews a pull request once when it opens and not on later pushes; after a later
commit that changes behaviour, comment `@coderabbitai review` on the final head and wait for it.
Which PRs wait for a review, and what stands in when CodeRabbit skips one, is in
[AGENTS.md](../AGENTS.md) (Maintainer workflow).
Release tags must not be moved or deleted. These GitHub settings are separate from files
in the checkout.

Expand Down