docs: add Claude Code config, guidelines, and coding standards#420
Merged
Conversation
|
🎉 This PR is included in version 4.0.4 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Add Claude Code configuration and coding standards
Summary
This PR adds configuration and documentation to support using Claude Code as an AI-assisted development tool for this repository.
What's included
CLAUDE.md— Project context file that gives Claude Code an understanding of the build system, test commands, architecture, and conventions. This allows Claude to be productive immediately without needing to rediscover project structure each session.docs/CODING_STANDARDS.md— Documents the coding patterns and conventions already in use across the codebase (TypeScript style, React patterns, testing approach, naming, formatting). This serves as both a contributor reference and guidance for Claude Code to follow existing patterns..claude/settings.json— Project-level permissions that auto-allow safe operations (test, lint, typecheck, build, read-only git) and deny destructive commands (force push, hard reset, rm -rf).Why
As the maintainer, Claude Code helps me move faster on bug fixes, features, and reviews. These files ensure it operates within the project's existing conventions rather than introducing inconsistent patterns. The coding standards doc also benefits human contributors by making implicit conventions explicit.
Notes
CLAUDE.mdand.claude/settings.jsonare used by Claude Code; they have no effect on builds, tests, or CI.