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 7Worked for most · soon

“documentation” Anthropic

unicity-sphereCLAUDE.md

sphere-sdk

unicity-sphere/sphere-sdk/CLAUDE.md

# CLAUDE.md - Sphere SDK Project Context This file provides context for Claude Code when working

5.4k7d agoReads credentialsDiscuss

breaking-brakeCLAUDE.md

patch version bump) - `improvement:` - Minor enhancement to existing feature (patch version bump) - `docs:` - Documentation only - `refactor:` - Code refactoring - `chore:` - Build/tooling changes #### What to Avoid ❌ Long explanations (Problem/Solution/Impact sections) ❌ Multiple paragraphs

5.4k3mo agoDiscuss

weave-osCLAUDE.md

router

weave-os/router/CLAUDE.md

swallow; don't log-and-continue on request path. The one documented exception is a **best-effort, off-request-path fire-and-forget** — always wrapped in [`observability.SafeGo`](internal/observability/safego.go) (bounded timeout

5.4k16d agoDiscuss

SenteLabsAICLAUDE.md

OpenExecutive

SenteLabsAI/OpenExecutive/CLAUDE.md

also gitignored. Structure: - `company/profile.yaml` — structured company profile (populated by onboarding wizard) - `company/docs/` — uploaded documents (indexed into ChromaDB) ## Code Style - Python: `ruff` for linting, `mypy` for type checking, `pytest` for tests

5.3k5d agoReads credentialsDiscuss

entireioCLAUDE.md

cli

entireio/cli/CLAUDE.md

reporting. - Existing exceptions (explicit user paths, global git config, transcript-read protocol gaps) are documented in the references; do not generalize them. ## Git and subprocess safety - Open repositories only through

5.1k3mo agoDiscuss

clideyCLAUDE.md

whodb

clidey/whodb/CLAUDE.md

ambiguous changes. - Use subagents only for bounded sidecar work: exploration, review, test triage, or documentation lookup. - Prefer separate worktrees for parallel implementation sessions. - When a task touches `ee/`, follow `ee/AGENTS.md

5k7d agoDiscuss

PeonPingCLAUDE.md

peon-ping

PeonPing/peon-ping/CLAUDE.md

vX.Y.Z` → Push tags: `git push --tags` → Update `../homebrew-tap/Formula/peon-ping.rb` URL and SHA256 if releasing ## Documentation rules **Whenever `README.md` is updated, also update all language variants:** - `README_zh.md` — Chinese translation (currently the only

5k6mo agoPipes a download into a shellDiscuss

MicrosoftCLAUDE.md

poml

microsoft/poml/CLAUDE.md

build-webview # Build webview components npm run build-cli # Build CLI tool # Build documentation and specs npm run generate-component-spec # Generate componentDocs.json and components.md npm run generate-vscodeignore # Generate

5k13mo agoDiscuss

MicrosoftCLAUDE.md

poml / poml-browser

microsoft/poml/packages/poml-browser/CLAUDE.md

React-based extension popup with Mantine components - **Common** (`common/`): Common utilities for clipboard, document handling, and POML processing (see below) ### Key Files - `manifest.json`: Chrome extension manifest - `rollup.config.mjs`: Build configuration with

5k13mo agoDiscuss

MicrosoftCLAUDE.md

FluidFramework

microsoft/FluidFramework/.claude/CLAUDE.md

vice versa. ## Coding Guidelines Follow the [Coding Guidelines](../docs/content/Guidelines/Coding-Guidelines.md) when writing / modifying code. ## Documentation Guidelines Follow the [Documentation Guidelines](../docs/content/Guidelines/Documentation-Guidelines.md) when writing or modifying code or documentation. Read and follow

4.9k56d agoDiscuss

MicrosoftCLAUDE.md

FluidFramework / historian

microsoft/FluidFramework/server/historian/CLAUDE.md

Context ## Overview Historian is a service that tracks the historical record for a Fluid document. It acts as a proxy to the underlying git repository that maintains versioned snapshots. ## Structure

4.9k56d agoDiscuss

Agenta-AICLAUDE.md

agenta

Agenta-AI/agenta/CLAUDE.md

read and follow all instructions in: @AGENTS.md Project conventions, guidelines, and best practices are documented there

4.8k2mo agoDiscuss

formkitCLAUDE.md

formkit

formkit/formkit/.dmux-hooks/CLAUDE.md

dmux Hooks System - Agent Reference **Auto-generated documentation for AI agents** This document contains everything an AI agent needs to create, modify, and understand dmux hooks. It is automatically generated

4.8k10mo agoReads credentialsDiscuss

conorbronsdonCLAUDE.md

avoid-ai-writing

conorbronsdon/avoid-ai-writing/CLAUDE.md

examples exempt from flagging) must be preserved — without it the skill flags its own documentation - Technical-blog profile has explicit word table exceptions (e.g., "robust" and "ecosystem" are legitimate

4.7k27d agoDiscuss

NateBJones-ProjectsCLAUDE.md

OB1

NateBJones-Projects/OB1/CLAUDE.md

phased execution. - Start with `.planning/STATE.md`, then read `.planning/PROJECT.md`, `.planning/ROADMAP.md`, and the relevant `.planning/codebase/*.md` documents. - Keep `.planning/` local. It is gitignored intentionally and is not part of the public contribution

4.6k7mo agoDeletes or force-pushesDiscuss

JetBrainsCLAUDE.md

koog / a2a

JetBrains/koog/a2a/CLAUDE.md

TaskOperationException`) - Propagate errors properly in async contexts - Include contextual information in exception messages #### KDoc Documentation - **Placement**: KDoc directly above declarations (classes, functions, properties) - **Constructor properties**: Document using `@param` tags

4.6k5mo agoDiscuss

breferrariCLAUDE.md

obsidian-mind

breferrari/obsidian-mind/CLAUDE.md

once to build the index. Note: the MCP connect-time banner can read "0 documents" when the server registers before the SessionStart reindex finishes — a stale snapshot, not the dead

4.6k45d agoDiscuss

SupabaseCLAUDE.md

supabase-js

supabase/supabase-js/.claude/CLAUDE.md

dependency duplication, and release coordination challenges while maintaining **zero breaking changes** for consumers. > **📚 Essential Documentation**: Always refer to these guides for detailed information: > > - **[CONTRIBUTING.md](../CONTRIBUTING.md)** - Development guidelines, commit format

4.6k6mo agoDeletes or force-pushesDiscuss

0xNykCLAUDE.md

council-of-high-intelligence

0xNyk/council-of-high-intelligence/CLAUDE.md

When changing protocol features in `SKILL.md`, mirror them in `SKILL.codex.md`, `SKILL.gemini.md`, and `SKILL.opencode.md` (or document why a host is exempt) — the checklist verifies parity - Test at least one mode (full/quick/duo

4.5k3mo agoDiscuss

StripeCLAUDE.md

stripe-node

stripe/stripe-node/.claude/CLAUDE.md

test section of @.github/workflows/ci.yml) ### Comments - Comments MUST only be used to: 1. Document a function 2. Explain the WHY of a piece of code 3. Explain a particularly complicated piece

4.5k55d 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.