Skip to content

docs: simplify repository instructions - #2046

Merged
zerob13 merged 3 commits into
devfrom
codex/simplify-repo-instructions
Jul 28, 2026
Merged

docs: simplify repository instructions#2046
zerob13 merged 3 commits into
devfrom
codex/simplify-repo-instructions

Conversation

@zerob13

@zerob13 zerob13 commented Jul 28, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • replace the CLAUDE.md symlink with a regular one-line Markdown pointer to AGENTS.md
  • reduce AGENTS.md from 75 lines to 20 focused repository guidelines
  • retain only the constraints that materially affect implementation, validation, and delivery
  • keep committed tests focused on project reliability, stability, and observable contracts while removing temporary implementation checks before handoff
  • require scope assessment before SDD and reserve it for large features or complex changes

Why

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

  • verified CLAUDE.md is a regular file with exact content READ [AGENTS.md](AGENTS.md)
  • verified AGENTS.md contains exactly 20 lines
  • ran git diff --check

Summary by CodeRabbit

  • Documentation
    • Simplified repository contribution guidelines into a concise checklist.
    • Clarified required tooling versions, coding standards, testing steps, commit conventions, and UI change documentation.
    • Removed outdated or overly detailed guidance.
    • Updated project documentation references.

@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Repository contribution guidance was condensed in AGENTS.md, while the prior CLAUDE.md reference content was cleared in the provided diff.

Changes

Repository guidance

Layer / File(s) Summary
Condensed contribution rules
AGENTS.md, CLAUDE.md
AGENTS.md now lists toolchain, coding, validation, branching, registry-refresh, and UI documentation requirements; the prior CLAUDE.md reference content was removed.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

Suggested reviewers: zhangmo8

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the docs-focused change to simplify repository instructions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/simplify-repo-instructions

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@zerob13
zerob13 marked this pull request as ready for review July 28, 2026 03:56
@zerob13
zerob13 merged commit cd2152c into dev Jul 28, 2026
11 of 12 checks passed

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 33914b2 and b3c2a41.

📒 Files selected for processing (3)
  • AGENTS.md
  • CLAUDE.md
  • CLAUDE.md

Comment thread AGENTS.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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 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.

Suggested change
- 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.

@zhangmo8
zhangmo8 deleted the codex/simplify-repo-instructions branch July 28, 2026 05:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant