CLAUDE.md is a special file that Claude automatically pulls into context when starting a conversation. This makes it an ideal place for documenting:
Common bash commands
Core files and utility functions
Code style guidelines
Testing instructions
Repository etiquette (e.g., branch naming, merge vs. rebase, etc.)
Developer environment setup (e.g., pyenv use, which compilers work)
Any unexpected behaviors or warnings particular to the project
Other information you want Claude to remember
There’s no required format for CLAUDE.md files. Anthropic recommenda keeping them concise and human-readable. For example:
# Bash commands- npm run build: Build the project- npm run typecheck: Run the typechecker# Code style- Use ES modules (import/export) syntax, not CommonJS (require)- Destructure imports when possible (eg. import { foo } from 'bar')# Workflow- Be sure to typecheck when you’re done making a series of code changes- Prefer running single tests, and not the whole test suite, for performance
You will want to read the Inbox Zero’s CLAUDE.md for a detailed description of these sections.
Nothing in this file is set in stone nor universally applicable; consider these suggestions as starting points. Anthropic encourages you to experiment and find what works best for you. This CLAUDE.md instructions are only applicable to Inbox Zero codebase.
I spent 200+ hours analyzing Supabase, shadcn/ui, LobeChat. Found the patterns that separate AI slop from production code. Stop refactoring AI slop. Start with proven patterns. Check out production-grade projects atthinkthroo.com