chore: add CLAUDE.md and AGENTS.md for AI agent guidelines - #1707
Merged
Conversation
Adds CLAUDE.md with project structure, boundaries, security considerations, and lazy-loaded reference docs covering commands, testing conventions, code style, git workflow, pitfalls, and docs-update rules. AGENTS.md imports CLAUDE.md for non-Claude agents.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1707 +/- ##
==========================================
- Coverage 86.10% 85.23% -0.87%
==========================================
Files 205 209 +4
Lines 31382 30080 -1302
==========================================
- Hits 27022 25640 -1382
- Misses 3379 3444 +65
- Partials 981 996 +15 🚀 New features to boost your workflow:
|
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
3 participants
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
CLAUDE.mdwith project structure, three-tier boundaries (Always Do / Ask First / Never Do), security considerations, and 6 lazy-loaded reference sectionsAGENTS.mdthat imports@./CLAUDE.mdfor non-Claude AI agentsreferences/directory withcommands.md,testing.md,code-style.md,git-workflow.md,pitfalls.md, anddocs-update.mdKey guidelines captured
NewResource()skeleton,HandleReadAPIErrorvs legacyHandleAPIError, mandatory schemaDescriptionfieldsmake test-unit), recorded acceptance (make test-acc), live e2e (make test-acc-e2e) with cassette workflowdocs/manually, always runmake docsafter schema changes, verify cassette redaction before committinggodot,errcheck,goimportslocal prefixTest plan
CLAUDE.mdfor accuracy against current codebase conventionsmaketargets listed inreferences/commands.mdexist in theMakefilereferences/paths match actual repo structure