Skip to content

docs: rewrite CLAUDE.md following best practices#178

Merged
avihut merged 2 commits intomasterfrom
daft-177/claude-md
Feb 6, 2026
Merged

docs: rewrite CLAUDE.md following best practices#178
avihut merged 2 commits intomasterfrom
daft-177/claude-md

Conversation

@avihut
Copy link
Owner

@avihut avihut commented Feb 6, 2026

Summary

  • Rewrites CLAUDE.md from 700 lines to 68 lines (~90% reduction) following Claude Code best practices
  • Removes content Claude can infer from code: directory listings, workflow tutorials, shortcut mapping tables, implementation details, changelog
  • Keeps only what Claude can't figure out on its own: critical rules, build/test/lint commands, architecture decisions, PR conventions, new command checklist

Test plan

  • Verified cargo fmt -- --check passes
  • Verified cargo clippy -- -D warnings passes
  • Verified just test-unit passes (206 tests)
  • Verify Claude Code sessions use the new CLAUDE.md effectively

Fixes #177

🤖 Generated with Claude Code

Reduce from 700 lines to 68 by removing content Claude can infer from
code (directory listings, workflow tutorials, shortcut tables, implementation
details) and keeping only what it can't figure out on its own (critical
rules, build commands, architecture decisions, PR conventions, new command
checklist).

Fixes #177

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@avihut avihut added this to the v1.1.0 milestone Feb 6, 2026
@avihut avihut added the docs Documentation changes label Feb 6, 2026
@avihut avihut self-assigned this Feb 6, 2026
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@avihut avihut merged commit 3a93795 into master Feb 6, 2026
@avihut avihut deleted the daft-177/claude-md branch February 6, 2026 21:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rewrite the CLAUDE.md file according to the best practices

1 participant