CLAUDE.md examples from real projects

How real projects brief Claude Code: the commands, conventions and warnings they put in CLAUDE.md.

Best matches · from page 22Worked for most · soon

typedef-aiCLAUDE.md

fenic

typedef-ai/fenic/CLAUDE.md

Auto-formats code examples in docstrings uv run ruff check . uv run ruff format . ``` ### Documentation ```bash # Preview documentation locally just preview-docs ``` ## Architecture Overview ### Directory Structure - `src/fenic/`: Main Python source

6723mo agoDiscuss

AffitorCLAUDE.md

affiliate-skills

Affitor/affiliate-skills/CLAUDE.md

readable index of all skills (auto-generated by `scripts/generate-registry.js`) - `evals/` — test cases - `docs/` — contributor documentation ## CLI tool: affiliate-check Persistent Bun daemon querying the openaffiliate.dev API. Port 9500, 5min cache

6717mo agoDiscuss

mhattingpeteCLAUDE.md

claude-skills-marketplace

mhattingpete/claude-skills-marketplace/CLAUDE.md

v1.1.0) - feature-planning, test-fixing, git-pushing, review-implementing - plan-implementer agent 2. **visual-documentation-skills** (v1.0.0) - visual-html-creator for stunning HTML documentation 3. **productivity-skills** (v1.0.0) - conversation-analyzer

66811mo agoDiscuss

realrossmanngroupCLAUDE.md

no_ai_slop_writing_rules

realrossmanngroup/no_ai_slop_writing_rules/CLAUDE.md

voice of Louis Rossmann, for general prose. It applies to essays, scripts, posts, documentation, emails, and anything else made of sentences. It is NOT tied to any wiki

6684mo agoDiscuss

product-on-purposeCLAUDE.md

pm-skills

product-on-purpose/pm-skills/CLAUDE.md

authoring then sweeping is much higher than the cost of internalizing the rule. ## Documentation Rules ### Public vs Private Files - Some internal working material is gitignored (for example `_NOTES/`, `_LOCAL

6668mo agoDiscuss

sodiumsunCLAUDE.md

agenttrail

sodiumsun/agenttrail/CLAUDE.md

owner corrects these on sight if wrong), `from: roadmap` when it comes from planning documents (durable intent, backloggable); omit when neither - new work NEVER creates a component by default

66323d agoDiscuss

henrydaumCLAUDE.md

second-brain

henrydaum/second-brain/CLAUDE.md

word for a source file and for a 150-byte JSON stub naming a document that lives in Drive. Anything routing on the modality alone reads the stub and reports

6627d agoReads credentialsDiscuss

innocommerceCLAUDE.md

innoshop

innocommerce/innoshop/CLAUDE.md

config.json # Required: Plugin configuration (NOT composer.json) ├── fields.php # Optional: Configuration field definitions ├── README.md # Recommended: Plugin documentation ├── Controllers/ # Optional: Controllers (Front/Panel subdirectories) │ ├── Front/ # Frontend controllers │ └── Panel/ # Admin panel controllers ├── Services/ # Optional: Service

6612mo agoReads credentialsDiscuss

joaoh82CLAUDE.md

rustunnel

joaoh82/rustunnel/CLAUDE.md

6557mo agoDiscuss

0xnynCLAUDE.md

airship

0xnyn/airship/.claude/CLAUDE.md

boundary conditions and error states 5. **User experience** - Accessibility, performance, and usability considerations 6. **Documentation** - Add comments for complex logic, but prefer self-documenting code --- Most formatting and common issues

65152d agoDiscuss

jaredrhodCLAUDE.md

ai-memory-vault / templates

jaredrhod/ai-memory-vault/templates/CLAUDE.md

always-on rule). **A daily-note entry alone is NEVER the documentation** — anything new gets a proper contextual home too: an existing note first, a new note in the right

65141d agoDiscuss

OSideMediaCLAUDE.md

higgsfield-ai-prompt-skill

OSideMedia/higgsfield-ai-prompt-skill/CLAUDE.md

ledger (one append-only file per project; _global.json generated; see db/ledger/README.md) docs/ ← Extended reference documents workspace/ ← Git-ignored working area (input/ → processed/, output/) .claude/ ├── settings.json ← Permission rules ├── rules/ ← Thin pointers

6485d agoDiscuss

samvallad33CLAUDE.md

vestige

samvallad33/vestige/CLAUDE.md

touch dashboard HTTP routes or MCP tools — frontend gates do not compile Rust. For documentation-only changes, at minimum run: ```sh git diff --check ``` ## Documentation - User setup: `README.md` - Claude-specific

6386mo agoDiscuss

umputunCLAUDE.md

agterm

umputun/agterm/CLAUDE.md

lines of comment, fix the code. - A doc comment longer than the body it documents is wrong. The usual cause is writing it to justify a review fix rather than

6342mo agoDiscuss

djydeCLAUDE.md

ccmate

djyde/ccmate/CLAUDE.md

when I need code generation, library installation, setup or configuration steps, or library/API documentation. This means you should automatically use the exa MCP tools get library docs without me having

62811mo agoDiscuss

orange2aiCLAUDE.md

claude-code-now

orange2ai/claude-code-now/CLAUDE.md

markdown ## 🚀 Claude Code Now v{VERSION} ✨ **New Features:** - 特性1描述 - 特性2描述 🐛 **Bug Fixes:** - 修复问题1 - 修复问题2 📝 **Documentation:** - 文档改进 🎯 **Philosophy:** Simple → Focused → Ultimate ``` --- ## 🎨 设计原则 ### 产品三段论 1. **预测** - 预测用户需求（快速启动） 2. **单点击穿** - 找到一个点（3秒启动

6289mo agoPipes a download into a shellDiscuss

Matt-DionisCLAUDE.md

claude-code-configs / claude-config-composer

Matt-Dionis/claude-code-configs/claude-config-composer/CLAUDE.md

Test keyboard navigation** manually 6. **Validate ARIA attributes** with accessibility tools ## Resources - [shadcn/ui Documentation](https://ui.shadcn.com) - [Radix UI Documentation](https://radix-ui.com) - [Tailwind CSS Documentation](https://tailwindcss.com) - [CVA Documentation](https://cva.style

62413mo agoDiscuss

danielealbanoCLAUDE.md

android-remote-control-mcp

danielealbano/android-remote-control-mcp/CLAUDE.md

crystal clear you MUST ask ## MANDATORY: Read These First You MUST ALWAYS read these documents before ANY work: - **`docs/PROJECT.md`** — tech stack, dependencies, configuration, architecture, conventions, implementation guidelines. This

6187mo agoReads credentialsDiscuss

emiliaprotocolCLAUDE.md

emilia-protocol

emiliaprotocol/emilia-protocol/CLAUDE.md

infer current behavior or standards status from archived, staged, private, or randomly sampled documents. ## Critical - **This repo is PUBLIC.** Everything tracked is world-readable. Business, strategy, GTM, investor, fundraising, outreach

6162mo agoDiscuss

HELPMEEADICECLAUDE.md

doge-code

HELPMEEADICE/doge-code/CLAUDE.md

class root `lint` script or automated `test` script in `package.json`. There is also no documented single-test command at the repository root, so validation is primarily targeted manual smoke testing

6096mo agoDiscuss

CLAUDE.md vs AGENTS.md

About CLAUDE.md

What is CLAUDE.md?

A file Claude Code reads at the start of every session. It holds the commands, conventions and warnings the agent needs for this project.

Where does it go?

At the repository root. Claude Code also reads CLAUDE.md files in subdirectories when it works there.

What should it contain?

Build and test commands, the project's layout, conventions that aren't obvious from the code, and mistakes to avoid. Short files tend to work better than long ones.

CLAUDE.md or AGENTS.md?

Claude Code reads CLAUDE.md; most other agents read AGENTS.md. Many projects keep one and point the other at it.