[PR #4339] docs: add CLAUDE.md orientation for Claude Code #6184

Open
opened 2026-10-31 01:12:30 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/4339
Author: @glenmo
Created: 10/16/2026
Status: 🔄 Open

Base: main ← Head: docs/claude-md


📝 Commits (1)

  • 9d6d1c2 docs: add CLAUDE.md orientation for Claude Code

📊 Changes

1 file changed (+62 additions, -0 deletions)

View changed files

➕ CLAUDE.md (+62 -0)

📄 Description

Summary

Adds a root CLAUDE.md so Claude Code sessions get repository orientation automatically. Claude Code loads CLAUDE.md, not AGENTS.md, so without it sessions start without the repo's commands or layering overview.

Problem and expected behavior

Use case: contributors using Claude Code. Expected outcome: a new session knows the build/test/check commands, the inward dependency layering, and generated-file ownership, and is directed to AGENTS.md as the binding source of invariants.

Change and scope

Documentation only. CLAUDE.md defers to AGENTS.md (and states that AGENTS.md wins on conflict) instead of duplicating its rules. It summarizes commands from package.json, docs/testing.md, and CONTRIBUTING.md, the layering from docs/architecture.mermaid, and generated-file ownership. No source, contract, or package changes. Maintainers may prefer a different approach (for example, a minimal CLAUDE.md that only references AGENTS.md); happy to adjust.

Contract and boundary impact

  • Semantic owner and earliest changed stage: repository documentation (CLAUDE.md)
  • Contribution scope fit and linked maintainer decision: not applicable (documentation only); maintainers to confirm whether a CLAUDE.md is wanted
  • CLI and MCP/tool-catalog contract: none
  • Provider, bridge, target-format, or platform compatibility: none
  • Evidence, artifact, provenance, or reconstruction contract: none
  • Target selection, authority, upstream behavior, and cleanup details (if applicable): not applicable
  • Generated metadata (docs/public/product-catalog.json), package, or installation impact: none; CLAUDE.md is not in package.json#files

Expected effects (check known effects; use documentation-only on its own).
Unchecked items do not establish absence; leave uncertainties visible.

  • Read existing files or captured data.
  • Launch or attach to a process.
  • Inject instrumentation or run scripts/code.
  • Change process memory, registers, files, or configuration.
  • Contact network services.
  • Recover protected code or work around protections.
  • Documentation or usability only; no target interaction.
  • Not sure yet; investigation or maintainer guidance needed.

Evidence and regression coverage

  • Tests added or updated: none (documentation only)
  • Base reproduction or other evidence: source-derived; commands and paths were taken from package.json, docs/testing.md, CONTRIBUTING.md, and docs/architecture.mermaid
  • User-visible CLI/MCP output (if applicable): not applicable
  • Remaining proof gaps: none known; the VitePress site builds from docs/, so it does not include the root CLAUDE.md

Validation performed

  • npx oxfmt --check CLAUDE.md — passed ("All matched files use the correct format")
  • Pre-commit hook — passed on commit
  • npm run check (Node 24.18.0) — passed: typecheck, lint (0 errors), format check, knip, metadata check, module boundaries, architecture guards
  • npm run docs:check (Node 24.18.0) — passed, including tests/conformance/readmeConsistency.test.ts (5/5)
  • npm run docs:build (Node 24.18.0) — passed (VitePress build complete; only the existing chunk-size warning)

Compatibility, safety, and release

  • Breaking changes or migration steps: none
  • Real Hopper/Ghidra, browser, or OS coverage: not applicable
  • Package or release metadata impact: none
  • Security, privacy, process, or containment review: not applicable

Author readiness

Human owner:

  • I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work.
  • I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps.
  • I declare this PR ready for initial maintainer review.

Before merge

  • This PR addresses a concrete problem or an agreed enhancement.
  • Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff.
  • The PR has one focused outcome and the title follows type(scope): outcome.
  • Related issue is linked, or the reason for not linking one is stated above.
  • Tests cover changed observable behavior and meaningful failure paths.
  • Owning docs, contracts, and generated metadata are updated where needed.
  • User-visible CLI/MCP changes include representative output.
  • I checked the final diff for secrets, unrelated cleanup, and unsupported claims.

🤖 Generated with Claude Code


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/morluto/rea/pull/4339 **Author:** [@glenmo](https://github.com/glenmo) **Created:** 10/16/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `docs/claude-md` --- ### 📝 Commits (1) - [`9d6d1c2`](https://github.com/morluto/rea/commit/9d6d1c2a144ddc12a4a7fdba923cf1409def5ebd) docs: add CLAUDE.md orientation for Claude Code ### 📊 Changes **1 file changed** (+62 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `CLAUDE.md` (+62 -0) </details> ### 📄 Description ## Summary Adds a root `CLAUDE.md` so Claude Code sessions get repository orientation automatically. Claude Code loads `CLAUDE.md`, not `AGENTS.md`, so without it sessions start without the repo's commands or layering overview. ## Problem and expected behavior Use case: contributors using Claude Code. Expected outcome: a new session knows the build/test/check commands, the inward dependency layering, and generated-file ownership, and is directed to `AGENTS.md` as the binding source of invariants. ## Change and scope Documentation only. `CLAUDE.md` defers to `AGENTS.md` (and states that `AGENTS.md` wins on conflict) instead of duplicating its rules. It summarizes commands from `package.json`, `docs/testing.md`, and `CONTRIBUTING.md`, the layering from `docs/architecture.mermaid`, and generated-file ownership. No source, contract, or package changes. Maintainers may prefer a different approach (for example, a minimal `CLAUDE.md` that only references `AGENTS.md`); happy to adjust. ## Contract and boundary impact - Semantic owner and earliest changed stage: repository documentation (`CLAUDE.md`) - Contribution scope fit and linked maintainer decision: not applicable (documentation only); maintainers to confirm whether a `CLAUDE.md` is wanted - CLI and MCP/tool-catalog contract: none - Provider, bridge, target-format, or platform compatibility: none - Evidence, artifact, provenance, or reconstruction contract: none - Target selection, authority, upstream behavior, and cleanup details (if applicable): not applicable - Generated metadata (`docs/public/product-catalog.json`), package, or installation impact: none; `CLAUDE.md` is not in `package.json#files` Expected effects (check known effects; use documentation-only on its own). Unchecked items do not establish absence; leave uncertainties visible. - [ ] Read existing files or captured data. - [ ] Launch or attach to a process. - [ ] Inject instrumentation or run scripts/code. - [ ] Change process memory, registers, files, or configuration. - [ ] Contact network services. - [ ] Recover protected code or work around protections. - [x] Documentation or usability only; no target interaction. - [ ] Not sure yet; investigation or maintainer guidance needed. ## Evidence and regression coverage - Tests added or updated: none (documentation only) - Base reproduction or other evidence: source-derived; commands and paths were taken from `package.json`, `docs/testing.md`, `CONTRIBUTING.md`, and `docs/architecture.mermaid` - User-visible CLI/MCP output (if applicable): not applicable - Remaining proof gaps: none known; the VitePress site builds from `docs/`, so it does not include the root `CLAUDE.md` ## Validation performed - `npx oxfmt --check CLAUDE.md` — passed ("All matched files use the correct format") - Pre-commit hook — passed on commit - `npm run check` (Node 24.18.0) — passed: typecheck, lint (0 errors), format check, knip, metadata check, module boundaries, architecture guards - `npm run docs:check` (Node 24.18.0) — passed, including `tests/conformance/readmeConsistency.test.ts` (5/5) - `npm run docs:build` (Node 24.18.0) — passed (VitePress build complete; only the existing chunk-size warning) ## Compatibility, safety, and release - Breaking changes or migration steps: none - Real Hopper/Ghidra, browser, or OS coverage: not applicable - Package or release metadata impact: none - Security, privacy, process, or containment review: not applicable ## Author readiness Human owner: <!-- @GitHub-handle --> - [ ] I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work. - [ ] I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps. - [ ] I declare this PR ready for initial maintainer review. ## Before merge - [ ] This PR addresses a concrete problem or an agreed enhancement. - [ ] Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff. - [ ] The PR has one focused outcome and the title follows `type(scope): outcome`. - [ ] Related issue is linked, or the reason for not linking one is stated above. - [ ] Tests cover changed observable behavior and meaningful failure paths. - [ ] Owning docs, contracts, and generated metadata are updated where needed. - [ ] User-visible CLI/MCP changes include representative output. - [ ] I checked the final diff for secrets, unrelated cleanup, and unsupported claims. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
morluto/rea#6184
No description provided.