docs: bootstrap AGENTS.md + CLAUDE.md shim (BE-3582)#40
Conversation
Author a root AGENTS.md (108 lines) as the single source of truth for agent instructions, per the org standard the repo's own agents-md-integrity workflow enforces, and a canonical one-line @AGENTS.md CLAUDE.md shim. AGENTS.md is written from the repo's actual contents: purpose, the exact build/test commands (each mirrors a CI test-*.yml job and was run green), the .github/ directory map, the reusable-workflow catalog, and the repo's real conventions/gotchas (public-repo caller-name masking, SHA-pin policy, scripts-as-single-source-of-truth tamper-proofing, the one-bumper rule, Conventional Commits + BE-#### suffix, semver major tags). Passes .github/agents-md-integrity/check_agents_md.py (only the warn-level CODEOWNERS-DRI note remains; adding a DRI is out of scope for this ticket).
|
Warning Review limit reachedYou’ve reached a temporary PR review limit under our Fair Usage Limits Policy. Next review available in: 54 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Comment |
There was a problem hiding this comment.
🔍 Cursor Review — Consolidated panel
Triggered by @mattmillerai.
✅ No high-signal findings.
Panel: 6/8 reviewers contributed findings.
Reviewers that did not contribute: kimi-k2.5:adversarial (empty), kimi-k2.5:edge-case (empty)
ELI-5
Agents (Claude Code, Cursor, etc.) look for a file that tells them how to work in
a repo. The cross-tool standard is
AGENTS.md; Claude Code specifically readsonly
CLAUDE.mdand won't fall back. This repo had neither, so agents touchingthese shared CI workflows got zero guidance. This PR adds a tight
AGENTS.md(the real source of truth) and a one-line
CLAUDE.mdshim that imports it — soevery agent, including Claude, gets the same instructions.
What this does
AGENTS.md(108 lines) — authored from the repo's actual contents:one-paragraph purpose, the exact build/test commands, the
.github/directorymap, the reusable-workflow catalog, and the repo's real conventions/gotchas
(public-repo caller-name masking, full-SHA pin policy, scripts-as-single-
source-of-truth tamper-proofing, the one-bumper rule, Conventional Commits +
(BE-####)suffix, semver major tags).CLAUDE.md— exactly the canonical@AGENTS.mdshim, nothing else.Implements the 2026-07-15 "Pillar 1: Agentic Engineering" standard — the same
one this repo's own
agents-md-integrity.ymlworkflow enforces on consumers.Verification
python3 .github/agents-md-integrity/check_agents_md.py --root .→ passes(108 < 200-line ceiling, valid
@AGENTS.mdshim, no.cursorrules). Only thewarn-level "no CODEOWNERS DRI" note remains — see judgment calls below.
AGENTS.mdwas copied verbatim from the CItest-*.ymlrun:steps and executed locally green:test-*workflowfires on these paths, so nothing existing is affected.
Judgment calls
"no DRI" note; it is not a failure, and picking a DRI is a decision the ticket
doesn't specify. Scoped this PR to
AGENTS.md+CLAUDE.mdper the ticket.Adding a CODEOWNERS rule for
AGENTS.mdis a clean follow-up.