Add CLAUDE.md for Claude Code guidance #438
Open
Conversation
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
This file provides comprehensive guidance for Claude Code instances working in this repository, including: - Essential development commands (testing, linting, documentation) - Core architecture and design patterns - Key considerations for metrics implementation - Contributing workflow 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
for more information, see https://pre-commit.ci
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
This PR adds a
CLAUDE.mdfile to provide comprehensive guidance for Claude Code instances working in this repository.What's Included
The CLAUDE.md file contains:
Development Commands - All essential commands for:
Architecture Documentation - High-level architecture that requires reading multiple files to understand:
Important Considerations - Critical knowledge about:
Contributing Workflow - Standard workflow for making changes
Rationale
This file helps future Claude Code instances (and human developers) quickly understand the codebase architecture and be productive when making changes. It focuses on the "big picture" that isn't immediately obvious from reading individual files.
🤖 Generated with Claude Code