How real projects brief Claude Code: the commands, conventions and warnings they put in CLAUDE.md.
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
go-delveCLAUDE.mdgo-delve/delve/CLAUDE.md
Shared type definitions ├── _fixtures/ # Test source files (compiled during tests) ├── _scripts/ # Build helper scripts └── Documentation/ # User and internal documentation ``` ## Dependencies Key external dependencies (see `go.mod`): - `github.com/cilium/ebpf` - eBPF program loading
No other project uses it yet
zama-aiCLAUDE.mdzama-ai/fhevm/relayer-http/CLAUDE.md
YAML scenarios run by the test suite; adding a case is adding a file. **Documentation.** Every module has a `docs.md` produced with the module and updated in the same change
CymChadCLAUDE.mdCymChad/BaseRecyclerViewAdapterHelper/CLAUDE.md
EMPTY_VIEW` companion constant points at `R.id.BaseQuickAdapter_empty_view`. ## Conventions - **Bilingual KDoc.** Public API documentation is written in **both Chinese and English** (Chinese typically first, then English). Match this style
No other project uses it yet
gitlabhqCLAUDE.mdgitlabhq/gitlabhq/doc/CLAUDE.md
Output requirements - Write the complete documentation. - Read and follow the documentation principles file before writing documentation. The principles file is at the repository root: open the `.ai` directory and read
No other project uses it yet
gitlabhqCLAUDE.mdgitlabhq/gitlabhq/workhorse/CLAUDE.md
GitLab Workhorse - Agent Guide This document provides guidance for AI agents working with the GitLab Workhorse codebase. ## Project Overview **GitLab Workhorse** is a smart reverse proxy for GitLab written
No other project uses it yet
SuperClaude-OrgCLAUDE.mdSuperClaude-Org/SuperClaude_Framework/CLAUDE.md
tests) ├── unit/ # Unit tests (auto-marked @pytest.mark.unit) └── integration/ # Integration tests (auto-marked @pytest.mark.integration) docs/ # Documentation scripts/ # Analysis tools (workflow metrics, A/B testing) plugins/ # Exported plugin artefacts for distribution PLANNING.md # Architecture
No other project uses it yet
beekeeper-studioReads credentialsCLAUDE.mdbeekeeper-studio/beekeeper-studio/CLAUDE.md
more. Database-specific connection logic is in `src/components/connection/` with corresponding client implementations in `src/lib/db/`. ## Documentation Build Rules The docs site (`docs/`, built by MkDocs from `mkdocs.yml`) builds in **strict mode
pubkeyCLAUDE.mdpubkey/rxdb/CLAUDE.md
CLAUDE.md ## Build Commands - **Build All**: `npm run build` - **Documentation Build**: `npm run docs:build` ## Test Commands - **Run All Tests**: `npm run test` - **Fast Tests (Parallel)**: `npm run test:fast` - **Fast
No other project uses it yet
czlonkowskiCLAUDE.mdczlonkowski/n8n-mcp/CLAUDE.md
Model Context Protocol) server that gives AI assistants access to n8n node documentation, workflow validation, and workflow management. Documentation and validation tools work offline against a bundled SQLite database
Steady19 mentions in 2 weeks
No other project uses it yet
microCLAUDE.mdmicro/go-micro/CLAUDE.md
Common MCP issues and solutions - **Error Handling Guide** - Patterns for agent-friendly error responses - **Documentation Guides** - Six guides: AI-native services, MCP security, tool descriptions, agent patterns, error handling, troubleshooting
No other project uses it yet
steipeteReads credentialsCLAUDE.mdsteipete/CodexBar/docs/claude.md
cookie-header accounts stay in manual cookie mode. The exact edge-routing rules are documented in [docs/refactor/claude-current-baseline.md](refactor/claude-current-baseline.md). - Cookie source order: 1) Safari: `~/Library/Cookies/Cookies.binarycookies` 2) Chrome/Chromium forks: `~/Library/Application Support/Google/Chrome/*/Cookies
getpaseoCLAUDE.mdgetpaseo/paseo/CLAUDE.md
pile of paragraphs in discovery order. `docs/custom-providers.md` is what that looks like. - **Don't document logic.** Prose that restates code drifts from the code and loses. Write down what
wavetermdevCLAUDE.mdwavetermdev/waveterm/CLAUDE.md
kilocode/rules/rules.md --- ## Skill Guides This project uses a set of "skill" guides — focused how-to documents for common implementation tasks. When your task matches one of the descriptions below, **read
Steady5 mentions in 2 weeks
1 project uses a version of this
react-grid-layoutCLAUDE.mdreact-grid-layout/react-grid-layout/CLAUDE.md
publishing correctly. ## Architecture (v2) The module structure, public API surface, and data models are documented in the generated maps in `codemaps/` (loaded at session start). Key notes not captured there
Steady8 mentions in 2 weeks
No other project uses it yet
QwikDevCLAUDE.mdQwikDev/qwik/CLAUDE.md
party actions. For new third-party actions, pin to a full commit SHA or document why a moving tag is acceptable. - Treat cache restore keys and artifact paths as untrusted
Steady8 mentions in 2 weeks
No other project uses it yet
ColorlibHQReads credentialsCLAUDE.mdColorlibHQ/gentelella/CLAUDE.md
setting ` `. At build/dev time the Vite plugin inlines sidebar/topbar/footer HTML directly into the document so the shell paints on the first frame — no FOUC. Runtime [src/v4/shell.js](src/v4/shell.js) `mountShell
No other project uses it yet
samberCLAUDE.mdsamber/lo/docs/CLAUDE.md
Adding New Helper Documentation When adding a new helper to the `lo` library, follow these guidelines to create or update documentation files in the `docs/data/` directory. ## File Structure Documentation files
No other project uses it yet
vitessioCLAUDE.mdvitessio/vitess/CLAUDE.md
least 30 seconds. - A test must exercise the condition that its name and documentation claim. - A test must fail on `main` without the fix that it protects. - A test must
No other project uses it yet
walkinglabsCLAUDE.mdwalkinglabs/learn-harness-engineering/CLAUDE.md
course on building reliable coding environments for AI agents. The repo contains a VitePress documentation site plus hands-on project code. ## Commands ```sh # Documentation site npm install npm run docs
Steady2 mentions in 2 weeks
No other project uses it yet
cube-jsCLAUDE.mdcube-js/cube/CLAUDE.md
server and core components - Client libraries for JavaScript/React/Vue/Angular - Database drivers for various data sources - Documentation site - Rust components (CubeSQL, CubeStore) ## Development Commands **Note: This project uses Yarn as the package
Steady7 mentions in 2 weeks
No other project uses it yet
A file Claude Code reads at the start of every session. It holds the commands, conventions and warnings the agent needs for this project.
At the repository root. Claude Code also reads CLAUDE.md files in subdirectories when it works there.
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 Code reads CLAUDE.md; most other agents read AGENTS.md. Many projects keep one and point the other at it.
