docs: Add comprehensive CLAUDE.md for AI-assisted development#2889
Merged
docs: Add comprehensive CLAUDE.md for AI-assisted development#2889
Conversation
Prevent git worktree directories from being tracked. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Add project-specific coding standards and Slither internals documentation to help developers using Claude Code (or similar AI tools) work effectively on the codebase. CLAUDE.md includes: - Architecture overview and development setup - Code standards (philosophy, quality, hard limits) - Working on code (incremental improvement, git conventions) - Testing guidelines - Slither internals (APIs, traversal patterns, SlithIR/SSA, detector quality) CONTRIBUTING.md additions: - PR description guidelines - Commit message conventions - Markdown documentation standards Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Code section: Remove verbose PR model explanation, fork link, "work from master" - Testing section: Tighten test categories to scannable list - Tips: Condense while adding coverage commands - crytic-compile section: Rename and simplify to numbered steps with example - CLAUDE.md: Add analyses/ to architecture, alphabetize directories Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
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
1 participant
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 project-specific coding standards and Slither internals documentation to help developers using Claude Code (or similar AI tools) work effectively on the codebase.
CLAUDE.md includes:
CONTRIBUTING.md additions:
Test plan
make lintpasses🤖 Generated with Claude Code