Skip to content

docs: add Claude Code config, guidelines, and coding standards#420

Merged
cchanxzy merged 1 commit into
mainfrom
docs/add-claude
Mar 17, 2026
Merged

docs: add Claude Code config, guidelines, and coding standards#420
cchanxzy merged 1 commit into
mainfrom
docs/add-claude

Conversation

@cchanxzy
Copy link
Copy Markdown
Owner

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

  • No source code or behavior changes — documentation and config only.
  • CLAUDE.md and .claude/settings.json are used by Claude Code; they have no effect on builds, tests, or CI.

@cchanxzy cchanxzy merged commit 94eb68d into main Mar 17, 2026
5 checks passed
@cchanxzy cchanxzy deleted the docs/add-claude branch March 17, 2026 07:59
@github-actions
Copy link
Copy Markdown

🎉 This PR is included in version 4.0.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant