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

VercelCLAUDE.md

lat.md

vercel-labs/lat.md/CLAUDE.md

responding to the user: - [ ] Update `lat.md/` if you added or changed meaningful functionality, architecture, tests, behavior, or planned work. Keep it a focused snapshot of current/planned state, not a journal/changelog

2k7d agoDiscuss

deusyuCLAUDE.md

translate-book

deusyu/translate-book/CLAUDE.md

conversion wrapper - `scripts/template.html`, `scripts/template_ebook.html` — HTML templates ## Prerequisites - **Python 3.12+** — the version CI runs. - **Unit tests need nothing else.** Every third-party import in `scripts/` is guarded (`try/except ImportError` or function

2k26d agoDiscuss

MicrosoftCLAUDE.md

PowerApps-Samples

microsoft/PowerApps-Samples/CLAUDE.md

Power Apps Portals samples (OAuth, Web API) - **powershell/** & **build-tools/**: Deployment automation ## Building and Testing ### Power Apps Component Framework (PCF) Each PCF control is a self-contained project with TypeScript/React

2k9mo agoDiscuss

doobidooCLAUDE.md

mcp-memory-service

doobidoo/mcp-memory-service/CLAUDE.md

SSH/network task, verify `hostname` and connection direction** (source → target). 12. **Report outcomes faithfully.** "Tests pass" means you ran them and saw them pass; if a step was skipped or failed

2k5d agoReads credentialsDiscuss

WorldFlowAICLAUDE.md

everything-claude-code / examples

WorldFlowAI/everything-claude-code/examples/CLAUDE.md

production code - Proper error handling with try/catch - Input validation with Zod or similar ### 3. Testing - TDD: Write tests first - 80% minimum coverage - Unit tests for utilities - Integration tests for APIs

2k9mo agoReads credentialsDiscuss

xu-xiangCLAUDE.md

everything-claude-code-zh

xu-xiang/everything-claude-code-zh/CLAUDE.md

Rules) 及 MCP 配置 (MCP Configurations) 的集合。本项目为使用 Claude Code 进行软件开发提供了经受过实战检验的工作流 (Workflows)。 ## 运行测试 (Running Tests) ```bash # 运行所有测试 node tests/run-all.js # 运行单个测试文件 node tests/lib/utils.test.js node tests/lib/package-manager.test.js node tests/hooks/hooks.test.js ``` ## 架构设计 (Architecture) 项目由以下核心组件组成： - **agents

1.9k7mo agoDiscuss

xu-xiangCLAUDE.md

everything-claude-code-zh / examples

xu-xiang/everything-claude-code-zh/examples/CLAUDE.md

创建实现方案 - `/code-review` - 代码质量评审 - `/build-fix` - 修复构建错误 ## Git 工作流 - 约定式提交（Conventional commits）：`feat:`, `fix:`, `refactor:`, `docs:`, `test:` - 严禁直接提交到 main 分支 - 合并请求（PRs）必须经过评审 - 所有测试必须通过后方可合并

1.9k7mo agoReads credentialsDiscuss

severity1CLAUDE.md

claude-code-prompt-improver

severity1/claude-code-prompt-improver/CLAUDE.md

choices - Uses AskUserQuestion tool for targeted clarifying questions (1-6 questions) ## Build & Development Commands **Testing:** - Run all tests: `pytest tests/` or `python -m pytest` - Run specific test suite: - Engine tests

1.9k8mo agoDiscuss

eneskircaCLAUDE.md

nodeterm

eneskirca/nodeterm/CLAUDE.md

Claude Code. **Contributors: start with `CONTRIBUTING.md`** — the short version (setup, boundaries, house rules, testing habits). This file is what you reach for when you need to know *why* a rule

1.9k8d agoReads credentialsDiscuss

the-open-engineCLAUDE.md

zeroshot

the-open-engine/zeroshot/CLAUDE.md

1.9k13d agoDiscuss

yoanbernabeuCLAUDE.md

grepai

yoanbernabeu/grepai/CLAUDE.md

this repository. ## Build and Development Commands ```bash # Build the binary make build # Run tests with race detection make test # Run tests with coverage report make test-cover # Lint with golangci

1.9k9mo agoDiscuss

vstorm-coCLAUDE.md

full-stack-ai-agent-template

vstorm-co/full-stack-ai-agent-template/CLAUDE.md

integrations. Uses Cookiecutter templates with Jinja2 conditionals. ## Commands ```bash # Install dependencies uv sync # Run tests uv run pytest # Run single test uv run pytest tests/test_file.py::test_name -v # Linting

1.9k6mo agoDiscuss

timescaleCLAUDE.md

pg-aiguide

timescale/pg-aiguide/CLAUDE.md

Tiger Docs MCP Server - Development Guidelines ## Build, Test & Run Commands - Build: `./bun run build` - Compiles TypeScript to JavaScript - Watch mode: `./bun run watch http` - Watches for changes and rebuilds automatically

1.9k29d agoDiscuss

Core-MateCLAUDE.md

OpenGUI

Core-Mate/OpenGUI/CLAUDE.md

Local Development Commands ### Server ```bash cd server ./start.sh ``` Useful commands: ```bash pnpm build pnpm test pnpm backend pnpm format-and-lint pnpm format-and-lint:fix pnpm --filter @repo/db

1.8k32d agoReads credentialsDiscuss

zzetCLAUDE.md

gortex

zzet/gortex/CLAUDE.md

local SQLite store and exposes it via CLI and MCP Server. ## Build & Test ```bash go build -o gortex ./cmd/gortex/ # requires CGO (tree-sitter C bindings) go test -race ./... # all test

1.8k6mo agoReads credentialsDiscuss

nimbalystCLAUDE.md

nimbalyst

nimbalyst/nimbalyst/CLAUDE.md

line names a symbol or a file, it's wrong. Internal-only changes (typecheck, tests, refactors, doc/agent tweaks, lint, dep bumps with no behavior change) get NO entry. **At release

1.8k5mo agoReads credentialsDiscuss

SupabaseCLAUDE.md

postgres

supabase/postgres/CLAUDE.md

truth for "what version are we on"); `nix/tests/` = pg_regress + smoke + migration NixOS tests; `nix/docs/` = the real developer docs (start here, not README) | | `ansible/` | Config management for the production

1.8k4mo agoDiscuss

a5c-aiCLAUDE.md

babysitter

a5c-ai/babysitter/CLAUDE.md

/docs/agent-reference/runtime-and-layout.md) - [docs/blueprints.md](./docs/blueprints.md) - [docs/plugins.md](./docs/plugins.md) ## Quick Commands ```bash npm run build:sdk npm run test:sdk npm run test:e2e:docker npm run verify:metadata ``` ## Claude Code Local Notes - `.claude/settings.json

1.8k3mo agoDiscuss

standardagentsCLAUDE.md

dmux

standardagents/dmux/.dmux-hooks/CLAUDE.md

with `#!/bin/bash` 4. **Use environment variables**: Access `$DMUX_ROOT`, `$DMUX_WORKTREE_PATH`, etc. 5. **Test it**: Set env vars manually and run the script ## Hook Execution Model - **Non-blocking**: Hooks

1.8k3mo agoReads credentialsDiscuss

dongsheng123132CLAUDE.md

u-claw

dongsheng123132/u-claw/CLAUDE.md

ext4 persistence image .\4-copy-to-usb.ps1 # Copy ISO + persistence + scripts to USB ``` ### Tests ```bash node --test "tests/*.test.mjs" # Run all tests (node:test, no test framework dep) # NOTE

1.8k45d agoPipes a download into a shellDiscuss

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.