docs: add CLAUDE.md shim importing AGENTS.md - #155
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Team Run ID: 📒 Files selected for processing (1)
Included review availability: 0 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 1 review per hour. 📝 WalkthroughWalkthroughCLAUDE.md now imports the shared AGENTS.md instructions and directs contributors to maintain instructions in AGENTS.md. ChangesInstruction synchronization
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~2 minutes Change: Other Suggested reviewers: Merge Risk: ⚪ Minimal · up to This change only adds the documented instruction shim and introduces no identified production or workflow risk. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🔍 Cursor Review — Consolidated panel
Triggered by @mattmillerai.
✅ No high-signal findings.
Panel: 6/6 reviewers contributed findings.
wei-hai
left a comment
There was a problem hiding this comment.
Reviewed the CLAUDE.md import shim; its AGENTS.md target exists and remains the instruction source. No blocking findings.
robinjhuang
left a comment
There was a problem hiding this comment.
Auto-approved under the full-autonomy policy.
Gates verified at 2a6fd4bd39d167a36bc4be30f9a0673af2dca95c:
full-autonomylabel present- assigned to, or review requested from, @robinjhuang
- not a draft
- 8 required check(s) green — none failing, none pending
This approval attests
that the machine gates above passed at this commit. It does not attest that a
human read the diff.
ELI-5
Claude Code reads
CLAUDE.md, notAGENTS.md, and does not fall back. This repoalready keeps all agent instructions in
AGENTS.md(the cross-tool standard).This adds a tiny
CLAUDE.mdthat just importsAGENTS.md, so Claude Code picksup the exact same instructions instead of finding nothing.
What changed
CLAUDE.mdcontaining only the canonical shim: an HTML commentexplaining the pattern plus
@AGENTS.md(which resolves relative to the shim'sdirectory).
AGENTS.mdis left byte-for-byte unchanged.Verification
CLAUDE.mdmatches the canonical shim exactly (verified viacat -A).AGENTS.mdunchanged:git diff origin/main -- AGENTS.mdis empty.public-repo-hygienegate passes locally(
python3 scripts/check_public_repo_hygiene.py→OK); the shim contains noticket-shaped ids, internal links, or repo refs.
AGENTS.mddocuments were cross-checked against.github/workflows/ci.ymland match (ruff check .,ruff format --check .,mypy src,pytest -v,python scripts/check_drift.py). No source, tests,generated models, or the sdist allowlist are touched, so the
test,codegen-drift, andbuild-checkjobs are unaffected by this doc-only file.Residual
AGENTS.mdtoo, but it alreadyexists on the default branch (197 lines, under the 200-line cap). The audited
"no AGENTS.md" snapshot predates its authoring and is now stale. Per acceptance
("AGENTS.md content unchanged unless told to trim/merge"), it was left intact;
this PR adds only the missing
CLAUDE.mdshim..cursorrulesexists anywhere in the tree (nothing to remove).AGENTS.mdexists, so no nested sibling shims are needed.reachable from this sandbox, so it was not exercised.
Provenance
public-repo-hygienepassed locally;AGENTS.mdconfirmedbyte-unchanged vs
origin/main;CLAUDE.mdconfirmed to match the canonicalshim exactly; documented commands cross-checked against CI config.
AGENTS.mdwas not authored because it already exists on thedefault branch; only the
CLAUDE.mdshim was added.Summary by CodeRabbit
AGENTS.md.AGENTS.md.