docs: simplify repository instructions - #2046
Conversation
📝 WalkthroughWalkthroughRepository contribution guidance was condensed in ChangesRepository guidance
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@AGENTS.md`:
- Line 5: Update the Node.js requirement in AGENTS.md to match the repository
contract in package.json: require Node >=24.14.1 and <25, while preserving the
existing pnpm >=10.11 requirement.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: ff81ca81-288b-46fe-909e-a107d9a691c2
📒 Files selected for processing (3)
AGENTS.mdCLAUDE.mdCLAUDE.md
| Core principles: specification-first, architectural consistency, minimal complexity, compatibility/migration awareness. | ||
| - Prefer the smallest correct change; add no abstraction or dependency without a real need. | ||
| - Preserve unrelated worktree changes; avoid destructive Git unless explicitly requested. | ||
| - Use pnpm only; require Node >=20.19 and pnpm >=10.11. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Align the documented Node.js requirement with the repository contract.
AGENTS.md says Node >=20.19, but package.json requires >=24.14.1 <25, and CI provisions Node 24.14.1. Following this guidance can lead contributors to use an unsupported Node version; document the exact supported range instead.
Proposed fix
-- Use pnpm only; require Node >=20.19 and pnpm >=10.11.
+- Use pnpm only; require Node >=24.14.1 <25 and pnpm >=10.11.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - Use pnpm only; require Node >=20.19 and pnpm >=10.11. | |
| - Use pnpm only; require Node >=24.14.1 <25 and pnpm >=10.11. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@AGENTS.md` at line 5, Update the Node.js requirement in AGENTS.md to match
the repository contract in package.json: require Node >=24.14.1 and <25, while
preserving the existing pnpm >=10.11 requirement.
Summary
CLAUDE.mdsymlink with a regular one-line Markdown pointer toAGENTS.mdAGENTS.mdfrom 75 lines to 20 focused repository guidelinesWhy
Symlinked instruction files behave poorly in snapshot tooling, while the previous repository guide repeated information an agent can discover from the project itself. A regular pointer file and a smaller guide are easier for tools and developers to consume.
Impact
Repository behavior is unchanged. Claude-compatible tools now read a regular file, and coding agents receive a shorter, higher-signal instruction set with explicit standards for durable tests and proportionate SDD usage.
Validation
CLAUDE.mdis a regular file with exact contentREAD [AGENTS.md](AGENTS.md)AGENTS.mdcontains exactly 20 linesgit diff --checkSummary by CodeRabbit