Skip to content

docs: add CLAUDE.md with repo-specific contributor and agent guidance - #328

Open
DsThakurRawat wants to merge 1 commit into
mainfrom
docs/claude-md
Open

docs: add CLAUDE.md with repo-specific contributor and agent guidance#328
DsThakurRawat wants to merge 1 commit into
mainfrom
docs/claude-md

Conversation

@DsThakurRawat

Copy link
Copy Markdown
Collaborator

Closes #327.

Adds a CLAUDE.md at the repo root. There was no CLAUDE.md, AGENTS.md or .claude/ anywhere before this, so anyone opening the repo with an AI assistant started cold, and a lot of contributors do start that way now.

It isn't a rewrite of the README or CONTRIBUTING. Those cover what the tool does and how to open a PR. This covers the things that are expensive to learn by hand.

What's in it

Verification

Every factual claim was checked against the tree at 8bcfc68 rather than written from memory. Specifically confirmed: the ../reflex_context/ default in receipt_test_support.py:13, the ruff==0.15.10 and mypy==1.20.1 pins in the workflows, the mypy override list for tether.exporters.monolithic, the err_console / console split in cli.py, the file counts (239 test files, 143 scripts, 396 source files), and the current open state of every issue referenced.

Risk

Documentation only. One new file, no code and no CI changes, so nothing here can affect a build.

The repo had no CLAUDE.md, AGENTS.md or .claude/ directory, so anyone
opening it with an AI assistant started with no repo-specific context and
had to rediscover the same traps by hand.

CONTRIBUTING.md covers the social process and README.md is user-facing.
Neither is the right place for "here is what will silently break your PR".

Documents what the package is, the layout after the reflex to tether
rename, and the things that are costly to learn the slow way: receipt
gated tests skipping silently (#292), the protected quality ratchet that
PRs cannot edit, the load-bearing dependency pin comments, uv.lock being
unused by CI (#294), and the stdout/stderr rule in the CLI.

Every claim is verified against the tree at 8bcfc68.

Closes #327

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019nFEvAJWGaUp1wRdqLGVjn
@DsThakurRawat

Copy link
Copy Markdown
Collaborator Author

@rylinjames flagging this one for you since it's mostly a record of decisions you made, and you're the right person to say whether I've written them down accurately.

Context: the repo has no CLAUDE.md or AGENTS.md, so contributors opening it with an AI assistant get no repo-specific context and rediscover the same traps by hand. #327 has the reasoning, this PR is the file.

Three things worth your eyes specifically:

Everything in the file was verified against the tree at 8bcfc68 rather than written from memory, so if something reads wrong it's likely my interpretation rather than a stale fact. Nothing here touches code or CI.

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.

docs: add CLAUDE.md with repo-specific contributor and agent guidance

1 participant