Add CLAUDE.md agent guide#1
Merged
Merged
Conversation
Surfaces the load-bearing invariants from docs/architecture.md (no asyncio, pure modules stay pure, frozen dataclasses, card ID redaction, fail-secure safety guards) so they bind without requiring a full read of the architecture doc. Includes uv-prefixed command list and a pointer to the architecture doc as authoritative. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds a root-level CLAUDE.md “agent guide” intended to surface the repo’s most important architecture constraints and common dev commands without requiring agents to read the full docs/architecture.md.
Changes:
- Introduces
CLAUDE.mdwith a concise project status note and workflow command list. - Summarizes “hard rules” from
docs/architecture.md(sync-only, purity boundaries, layering, redaction, dry-run, safety fail-secure). - Documents testing and config layout expectations for future implementation work.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+12
to
+15
| uv run mypy src tests # type check (strict) | ||
| uv run ruff check . # lint | ||
| uv run door-sync --once # one reconcile cycle, exit | ||
| uv run door-sync --dry-run # compute + log diff; no UniFi writes |
Comment on lines
+14
to
+15
| uv run door-sync --once # one reconcile cycle, exit | ||
| uv run door-sync --dry-run # compute + log diff; no UniFi writes |
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.
Summary
Adds a
CLAUDE.mdat the repo root to give Claude Code (and other agents) load-bearing context without requiring a full read ofdocs/architecture.md.What's in it
uv runcommand list — non-obvious for tools trained on plainpytest/mypy.docs/architecture.mdas authoritative for module layout and data contracts.reconciler,safety,tier_mapping) stay pureWhy
The architecture doc is thorough (430+ lines) but agents won't always read it before touching code. Surfacing the rules that, if violated, would silently corrupt the design intent — async migration, logging inside pure modules, full card IDs in logs — makes them bind without depending on the agent reading the full doc.
Kept short (~40 lines) on purpose: a longer file would duplicate
docs/architecture.mdand drift.Test plan
docs/architecture.md.uv runcommands work locally.🤖 Generated with Claude Code