docs: guidance for future Claude Code instances, as CLAUDE.md - #2
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new root-level CLAUDE.md intended to be loaded by Claude Code as repository guidance, documenting the repo’s command “gate”, architecture map of packages/di/src, and a few binding design rules so future automated/codegen passes match established project constraints.
Changes:
- Introduces
CLAUDE.mdwith contributor workflow commands (format/lint/typecheck/test/knip/build) and scoping examples. - Documents the DI container’s architecture and key type-level/runtime invariants (ports/providers/modules/build pipeline, scope lifecycle, type-level tests).
- Captures binding design rules (comments as regression guards, errors-as-values discipline, “one name per concept”).
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
What
Adds a
CLAUDE.mdat the repo root — the file Claude Code loads as repository guidance.Contents
packages/di, type-level tests, and the commitlint/changeset conventions.packages/di/srcwith the load-bearing design points — nominal port identity via unexported symbol brands, the mutually exclusive construction arms, the phantom-channel variance rule, the arity-basedUNSATISFIED DEPENDENCIESgate, andWiringDefectthrows routed to unthrown'sDefectchannel — plus the*.test-d.tssetup, the dual-TypeScript-version emit check, and the examples-as-tests arrangement.unthrown/*lint rules are binding, one name per concept.No changeset: internal tooling documentation, no API or behaviour impact.