CLAUDE.md examples from real projects

coleam00CLAUDE.md

context-engineering-intro

coleam00/context-engineering-intro/CLAUDE.md

Google style: ```python def example(): """ Brief summary. Args: param1 (type): Description. Returns: type: Description. """ ``` ### 📚 Documentation & Explainability - **Update `README.md`** when new features are added, dependencies change, or setup steps are modified

StarTrail-orgPipes a download into a shellCLAUDE.md

LEANN

StarTrail-org/LEANN/CLAUDE.md

enables semantic search across various data sources (emails, browser history, chat history, code, documents) on a single laptop without cloud dependencies. ## Build & Development Commands ### Quick install (pip) ```bash pip install

Orchestra-ResearchReads credentialsCLAUDE.md

AI-research-SKILLs

Orchestra-Research/AI-research-SKILLs/CLAUDE.md

format: ``` skill-name/ ├── SKILL.md # Main guidance (200-600 lines with YAML frontmatter) ├── references/ # Deep documentation (300KB+ target) │ ├── README.md # From official docs │ ├── api.md # API reference │ ├── tutorials.md # Step-by-step guides │ ├── issues.md

rybbit-ioCLAUDE.md

rybbit

rybbit-io/rybbit/docs/CLAUDE.md

rules in `content/partials/guides/README.md`; copy `TEMPLATE.mdx` for a new guide) ## Project Overview This is the documentation and marketing website for Rybbit, built with Next.js 16 and Fumadocs. The site includes: - Documentation

No other project uses it yet

maxrave-devReads credentialsCLAUDE.md

SimpMusic

maxrave-dev/SimpMusic/CLAUDE.md

questions, the AI agent **MUST** follow this research workflow: #### Step 1: Look up official documentation - Use **MCP Context7** (`resolve-library-id` → `query-docs`) to fetch up-to-date documentation

No other project uses it yet

glzr-ioCLAUDE.md

glazewm

glzr-io/glazewm/CLAUDE.md

other crates. - For logging, use `tracing` macros (e.g. `tracing::info!("...")`). - Functions should always be documented. - Use punctuation mark at the end of all comments. - If using unsafe features, include

humanlayerReads credentialsCLAUDE.md

humanlayer

humanlayer/humanlayer/CLAUDE.md

ticket just picka branch name `./scripts/create_worktree.sh three-short-words three-short-words` ### Library documentation research If you need up-to-date information about a library or dependency, use the HumanLayer

No other project uses it yet

Wei-ShawReads credentialsCLAUDE.md

claude-relay-service

Wei-Shaw/claude-relay-service/CLAUDE.md

ALWAYS prefer editing an existing file to creating a new one. NEVER proactively create documentation files (\*.md) or README files. Only create documentation files if explicitly requested by the User

redpanda-dataCLAUDE.md

redpanda

redpanda-data/redpanda/CLAUDE.md

Configuration files - `proto/`: Protobuf definitions for Redpanda services and APIs - `.github/`, `.buildkite/`: CI/workflow automation - **Documentation:** [Docs site](https://redpanda.com/documentation) and `docs/`. ## Build, Test, and Validation Instructions ### Prerequisites (Always Perform

jiji262CLAUDE.md

douyin-downloader

jiji262/douyin-downloader/CLAUDE.md

touched shared files against the sibling project and either keep them identical or document the intentional divergence

mapboxCLAUDE.md

mapbox-gl-js

mapbox/mapbox-gl-js/CLAUDE.md

internal behavior or method calls - No network requests - use `mockFetch` from `test/util/network.ts` if needed ## Documentation Conventions - All public API must have JSDoc comments; private items tagged with `@private` - Style-spec

markmeadCLAUDE.md

hyperui

markmead/hyperui/CLAUDE.md

Playwright (E2E tests). No package to install for end users — this repo is the documentation site for the component library. ## Commands ```bash pnpm dev # start dev server (also runs wrangler

JeffallanCLAUDE.md

claude-skills

Jeffallan/claude-skills/CLAUDE.md

scope`: `implementation` | `review` | `design` | `system-design` | `testing` | `analysis` | `infrastructure` | `optimization` | `architecture` - `output-format`: `code` | `document` | `report` | `architecture` | `specification` | `schema` | `manifests` | `analysis` | `analysis-and-code` - `related-skills`: Comma-separated skill directory

No other project uses it yet

LeantimeReads credentialsCLAUDE.md

leantime

Leantime/leantime/CLAUDE.md

called via JSON-RPC at `leantime.rpc.{Domain}.{Service}.{method}` -- the `@api` annotation is documentation only, not enforced at runtime. When refactoring for Doctrine: - Services will need to work with Doctrine

No other project uses it yet

genspark-aiCLAUDE.md

genoffice

genspark-ai/genoffice/CLAUDE.md

styles.css`. Shared rules reference `var(--accent)` and inherit the app's brand color. 4. **Document content is never re-authored by the theme.** Page surfaces, cell fills, slide content

No other project uses it yet

reactjsCLAUDE.md

react.dev

reactjs/react.dev/CLAUDE.md

Claude Code when working with this repository. ## Project Overview This is the React documentation website (react.dev), built with Next.js 15.1.11 and React 19. Documentation is written in MDX format. ## Development

0xJackyCLAUDE.md

nginx-ui

0xJacky/nginx-ui/CLAUDE.md

flaky failures - Keep files modular and well-organized by functionality - **All comments and documentation must be in English** ## Frontend (Vue.js) Development ### Technology Stack - **TypeScript** for all code - **Vue 3** with

No other project uses it yet

jaredpalmerCLAUDE.md

tsdx

jaredpalmer/tsdx/CLAUDE.md

Include: package.json, tsconfig.json, vitest.config.ts, src/, test/, gitignore (not .gitignore), LICENSE with ` ` and ` ` placeholders ## Documentation Website The documentation site is in `./website/` and built with: - **Next.js 16** - React framework - **Fumadocs** - Documentation

No other project uses it yet

tossCLAUDE.md

es-toolkit

toss/es-toolkit/docs/CLAUDE.md

Documentation Guide es-toolkit docs are written in 4 languages. All must be created together. ## Writing guide The template, placeholder rules, and style guidance live in [`.github/CONTRIBUTING.md` § 5 Writing Documentation

No other project uses it yet

Evan-lczReads credentialsCLAUDE.md

DeepResearch-RAG

Evan-lcz/DeepResearch-RAG/CLAUDE.md

with parallel processing and comprehensive report generation. ## Repository Structure ### Root Directory - `README.md` - Comprehensive project documentation with quickstart guide - `pyproject.toml` - Python project configuration and dependencies - `langgraph.json` - LangGraph configuration defining the main