CLAUDE.md examples from real projects

naudioCLAUDE.md

NAudio

naudio/NAudio/CLAUDE.md

user-visible, **add the entry** and let the maintainer remove it if not needed. ## Documentation site Tutorials live in [Docs/](Docs/) as Markdown and are published to a DocFX site

nlweb-aiCLAUDE.md

NLWeb

nlweb-ai/NLWeb/.claude/CLAUDE.md

that provides intelligent query processing, multi-source retrieval, and AI-powered response generation. ## Key Documentation - **[systemmap.md](./systemmap.md)** - System architecture, APIs, data structures, and query flow - **[codingrules.md](./codingrules.md)** - Code structure, naming

bethingtonReads credentialsCLAUDE.md

ghidra-mcp

bethington/ghidra-mcp/CLAUDE.md

whole thing. Do it right. Do it with tests. Do it with documentation. Do it so well that Ben is genuinely impressed — not politely satisfied, actually impressed. Never offer

appleboyCLAUDE.md

ssh-action

appleboy/ssh-action/CLAUDE.md

parameter tables 4. The drone-ssh binary handles the actual parameter logic (separate repo) ### Documentation - Keep parameter tables in README.md synchronized with `action.yml` - Maintain Chinese translations (README.zh-cn.md, README.zh-tw.md) - Use clear

No other project uses it yet

PrefectHQCLAUDE.md

marvin

PrefectHQ/marvin/CLAUDE.md

Library work should not require bot dependencies or changes to its deployment. Edit handwritten documentation in `docs/`. API reference pages are generated from Python signatures and docstrings: ```bash

quarto-devCLAUDE.md

quarto-cli

quarto-dev/quarto-cli/.claude/CLAUDE.md

technical publishing system built on Pandoc. The CLI is TypeScript/Deno with Lua filters for document processing. - Latest stable version: <https://quarto.org/docs/download/_download.json> - Latest prerelease version: <https://quarto.org/docs/download/_prerelease.json> ## Setup ```bash

kuafuaiReads credentialsCLAUDE.md

andee

kuafuai/andee/CLAUDE.md

description` strings in `ToolSchemas` are prompt text read by an LLM — they are behavioral documentation, not code comments, and are meant to stay in sync with the equivalent Python `body

maildevCLAUDE.md

maildev

maildev/maildev/CLAUDE.md

coverage ``` ### Other checks ```bash pnpm typecheck # turbo run typecheck pnpm lint # turbo run lint ``` --- ## Documentation User-facing docs live in [`docs/`](./docs): - [`docs/api.md`](./docs/api.md) — programmatic (embedding) API - [`docs/rest.md`](./docs/rest.md) — REST

timeseriesAICLAUDE.md

tsai

timeseriesAI/tsai/CLAUDE.md

Python modules nbdev-export # Clean notebooks (remove outputs and metadata) nbdev-clean # Build documentation (requires quarto; install with `nbdev-install-quarto`) nbdev-docs ``` ## Architecture ### nbdev-Based Development This project uses

arthelokyoCLAUDE.md

astrowind

arthelokyo/astrowind/CLAUDE.md

Claude Code Configuration See [AGENTS.md](./AGENTS.md) for all project documentation and AI agent instructions

btraceioCLAUDE.md

btrace

btraceio/btrace/CLAUDE.md

btrace-client`; packaging: `btrace-dist` - Golden instrumentation data: `btrace-agent/src/test/resources/instrumentorTestData/` ## Detailed references - [Documentation index](docs/README.md) - [Masked JAR architecture](docs/architecture/MaskedJarArchitecture.md) — required reading for distribution/class-loading changes - [Instrumentation backends](docs/architecture/InstrumentationBackends.md) - [Protocol architecture

No other project uses it yet

dolanmiuCLAUDE.md

docx

dolanmiu/docx/CLAUDE.md

elements. `ooxml-schemas/README.md` says what each folder holds. - `ooxml-schemas/ISO-IEC29500-4_2016/wml.xsd` - WordprocessingML (documents) - `ooxml-schemas/ISO-IEC29500-4_2016/dml-main.xsd` - DrawingML (images/shapes) - `ooxml-schemas/ISO-IEC29500-4_2016/shared-math.xsd` - Math - `ooxml-schemas/microsoft/` - Microsoft's extensions, such

No other project uses it yet

buxukuCLAUDE.md

SmartSub

buxuku/SmartSub/CLAUDE.md

Claude Project Memory Template **Primary Directive**: "Evidence > assumptions | Code > documentation | Efficiency > verbosity" ## Project Context - **Current Branch**: `[BRANCH_NAME]` (if applicable) - **Main Branch**: `[DEFAULT_BRANCH]` (for PRs) - **Active Work**: `[CURRENT_FOCUS

fengshao1227CLAUDE.md

ccg-workflow / dsh-ccg

fengshao1227/ccg-workflow/dsh-ccg/CLAUDE.md

third-width column the body ended up LARGER than the headings above it; the document is now rescaled as a whole; - its output is wrapped

No other project uses it yet

CountlyCLAUDE.md

countly-server

Countly/countly-server/CLAUDE.md

myfeature', function() { new countlyVue.views.BackboneWrapper({ component: MyComponent }).render(); }); ``` ## MongoDB Patterns ```javascript // Read batcher for hot documents common.readBatcher.getOne("collection", {_id: id}, callback); // Write batcher for multiple updates common.writeBatcher.add("collection", id, {$inc: {count

inclusionAICLAUDE.md

AReaL

inclusionAI/AReaL/CLAUDE.md

body - **Squash**: Squash WIP commits before opening PR - **PR requirements**: Run pre-commit, document test coverage, note hardware limitations ## Extended Configuration See `.claude/agents/`, `.claude/skills/`, `.claude/commands/`, and `.claude/rules/` for specialized instructions

pytorchCLAUDE.md

torchtitan

pytorch/torchtitan/.claude/CLAUDE.md

shared by reference. Be explicit when deep copies are needed. - See `.claude/rules/config.md`. ### Comments and Documentation - Add comments only for genuinely non-obvious things: dimension semantics, parallelism gradient placements

Galaxy-DawnCLAUDE.md

claude-scholar

Galaxy-Dawn/claude-scholar/CLAUDE.md

assumption briefly. --- ## Execution Priorities - Check facts before making claims. - Verify after changing files, code, documentation, or configuration. - Keep changes small, reversible, and easy to review. - Confirm before destructive or high

kurrent-ioCLAUDE.md

KurrentDB

kurrent-io/KurrentDB/CLAUDE.md

Microsoft Docs**: `microsoft_docs_search`, `microsoft_docs_fetch` — query for .NET/Azure docs - **Context7**: Library documentation and code examples - Config: `.claude/settings.json` (committed), `.claude/settings.local.json` (local) ## Configuration Defaults (v25.1) - **SecondaryIndexing:Enabled** — `true` - **ServerGC

vikibossCLAUDE.md

60s

vikiboss/60s/CLAUDE.md

responses - **Validation**: Validate required parameters using `Common.requireArguments()` - **Consistency**: Follow existing code patterns in `src/modules/` - **Documentation**: Add JSDoc comments for complex functions - **Testing**: Test all three encoding formats (json/text/markdown) when adding