docs: add CLAUDE.md - #1
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a repository-root CLAUDE.md to document the project’s development commands, core architecture, and binding conventions so future Claude Code sessions can start from an accurate mental model without rediscovering it.
Changes:
- Introduces
CLAUDE.mddescribing the monorepo/tooling commands and CI “gate” sequence. - Summarizes the package architecture (builder/types/instance/shape/add+errors) and key design rules (contracts vs
instance). - Records binding conventions (errors-as-values, measurement-as-regression-guard comments, type-level tests, peer deps, and
catalog:dependency protocol).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Adds a
CLAUDE.mdat the repo root so future Claude Code sessions start with therepository's commands, architecture and binding conventions instead of rediscovering them.
Contents
single test file or a single test from inside
packages/entity.entity.tsas the builderwhere every entry point funnels through
construct,types.tsas the type-levelderivation plus the
Sealedconstruction lock,instance.ts's self-overwriting getterand why a plain value would build the base class,
shape.ts's branded-field check. Plusthe rule the design turns on — contracts compose the four plain
ZodObjects, domain codecomposes
instance.unthrown/*oxlint rules, themeasurement-citing comments (TS2411/2526/4020/4111, the pinned
typescriptand@orpc/zodcatalog entries) as regression guards,*.test-d.tsas the home ofcompile-time guarantees, peer deps and the
catalog:protocol.Docs only — no source, config or behaviour changes.