docs: add CLAUDE.md with repo-specific contributor and agent guidance - #328
Open
DsThakurRawat wants to merge 1 commit into
Open
docs: add CLAUDE.md with repo-specific contributor and agent guidance#328DsThakurRawat wants to merge 1 commit into
DsThakurRawat wants to merge 1 commit into
Conversation
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
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 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #327.
Adds a
CLAUDE.mdat the repo root. There was noCLAUDE.md,AGENTS.mdor.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
*_cert/*_receipt/*_proof/verify*files don't get treated as dead weight.src/reflex/is a compat shim where no logic should ever go.receipt_test_support.pypoints at../reflex_context/, which isn't in this repo. A green run is therefore not proof of parity ([C2] Receipt-gated parity/latency tests always skip in CI (green proves no parity) #292).pyproject.tomlto get around it.transformerspins each encode a real production failure in their comments, so they look removable but aren't.uv.lockis committed but CI resolves floating deps with pip ([C4]uv.lockcommitted but unused in CI; pip resolves floating deps #294).doctor#298).GOALS.yamlstaleness [C6]GOALS.yaml~3mo stale; infra resources still namedreflex-*#296, license mismatch [C7] Packaging license mismatch: BUSL-1.1 declared, Apache classifier #297) flagged so nobody copies them forward.Verification
Every factual claim was checked against the tree at 8bcfc68 rather than written from memory. Specifically confirmed: the
../reflex_context/default inreceipt_test_support.py:13, theruff==0.15.10andmypy==1.20.1pins in the workflows, the mypy override list fortether.exporters.monolithic, theerr_console/consolesplit incli.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.