CLAUDE.md examples from real projects

streamyfinCLAUDE.md

streamyfin

streamyfin/streamyfin/CLAUDE.md

file is an index, not a manual. When a topic below points at a document, read that document before relying on assumptions: most of these rules exist because their absence

gluestackCLAUDE.md

gluestack-ui

gluestack/gluestack-ui/CLAUDE.md

mappers sync. ``` src/ ├── components/ui/ # All UI components (Button, Input, Modal, etc.) ├── docs-components/ # Documentation-specific components (website only) ├── docs/ # Component docs/examples (website only) └── sidebar.json # Documentation sidebar config (website only) apps

No other project uses it yet

fallow-rsCLAUDE.md

fallow

fallow-rs/fallow/CLAUDE.md

imported: the universal repository contract for Claude, Codex, and contributors, and the central documentation index. Read `docs/development/task-context-map.md` next to load only the references the current task needs. ## Knowledge layers - `.agents/skills

No other project uses it yet

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

No other project uses it yet

umbracoCLAUDE.md

Umbraco-CMS

umbraco/Umbraco-CMS/CLAUDE.md

framework - **Entity Framework Core** - Modern ORM - **OpenIddict** - OAuth 2.0/OpenID Connect authentication - **Microsoft.AspNetCore.OpenApi** - OpenAPI document generation - **Swashbuckle.AspNetCore.SwaggerUI** - Swagger UI for API documentation - **Lucene.NET** - Full-text search via Examine - **ImageSharp** - Image

Hufe921CLAUDE.md

canvas-editor

Hufe921/canvas-editor/CLAUDE.md

cypress:run` - Run Cypress tests headlessly - `npm run docs:dev` - Start VitePress documentation server - `npm run docs:build` - Build VitePress documentation - `npm run release` - Run release script

chakra-uiCLAUDE.md

zag

chakra-ui/zag/CLAUDE.md

Zag.js AI Agent Instructions ## Documentation For detailed information on specific topics, see: - `@.claude/docs/commands.md` - All available commands and workflows - `@.claude/docs/architecture.md` - Code organization and structure - `@.claude/docs/guidelines.md` - Development guidelines and best practices - `@.claude/docs/common-tasks.md

No other project uses it yet

InternLMCLAUDE.md

xtuner

InternLM/xtuner/.claude/CLAUDE.md

pyproject.toml`). ### Docstring Standards 1. Use **Google Style** docstrings. 2. For classes, include `__init__` documentation directly under the **class docstring**; do not repeat it under the `__init__` method. 3. Parameter types

IsmaelMartinezCLAUDE.md

teams-for-linux

IsmaelMartinez/teams-for-linux/CLAUDE.md

Claude Code (claude.ai/code) when working with code in this repository. > [!NOTE] > **For comprehensive documentation**, see the markdown files in `docs-site/docs/` directory. These files are the source

No other project uses it yet

linuxhsjCLAUDE.md

openclaw-zero-token / plugins

linuxhsj/openclaw-zero-token/plugins/CLAUDE.md

should work from metadata before plugin runtime executes. - Keep loader behavior aligned with the documented Plugin SDK and manifest contracts. Do not create private backdoors that bundled plugins

Jeric-XCLAUDE.md

SyncClipboard

Jeric-X/SyncClipboard/CLAUDE.md

commits into the local `master` branch only. It does not authorize a remote push. ## Documentation - AI-generated or AI-maintained design documents must be stored in `docs/ai_design/`. - Keep `AGENTS.md

tixl3dCLAUDE.md

tixl

tixl3d/tixl/.claude/CLAUDE.md

lasting *why* inline. (Agent-neutral rule; full version under "Comment Restraint" in AGENT_INSTRUCTIONS.) ## Documentation, Tests, and Background These rules are agent-neutral and live in [`.agentic/AGENT_INSTRUCTIONS.md`](../.agentic/AGENT_INSTRUCTIONS.md

colanodeReads credentialsCLAUDE.md

colanode

colanode/colanode/CLAUDE.md

registry. Foundation for all other packages. - **`packages/crdt`** - CRDT implementation wrapping Yjs. Provides type-safe document updates and conflict-free merging. - **`packages/client`** - Client-side services, local SQLite database schema

liam-hqCLAUDE.md

liam

liam-hq/liam/CLAUDE.md

test ``` ## Architecture ### Monorepo Structure #### Applications - **frontend/apps/app** - Main Next.js web application (`@liam-hq/app`) - **frontend/apps/docs** - Documentation site (`@liam-hq/docs`) #### Public Packages - **frontend/packages/cli** - Command-line tool (`@liam-hq/cli`) - **frontend/packages/erd-core** - Core

pytorchCLAUDE.md

executorch

pytorch/executorch/CLAUDE.md

authored with AI, include tool name. ## Code Style - Minimal comments; code should be self-documenting - Comments only for non-obvious global context - No trivial (1-2 LOC) single-use helpers

tencentmusicCLAUDE.md

supersonic

tencentmusic/supersonic/CLAUDE.md

webapp/packages/supersonic-fe/` **Evaluation scripts:** Python scripts in `evaluation/` directory for Text2SQL accuracy testing. ## Related Documentation - [README.md](README.md) - English documentation - [README_CN.md](README_CN.md) - Chinese documentation - [Evaluation Guide](evaluation/README.md) - Text2SQL evaluation process

rstudioCLAUDE.md

rstudio

rstudio/rstudio/.claude/CLAUDE.md

Playwright, under `e2e/rstudio/`. They drive the IDE through a JS automation bridge at `window.rstudio`, documented in `e2e/rstudio/CLAUDE.md`. See `.claude/skills/rstudio-create-playwright-tests/SKILL.md` for detailed guidance on writing Playwright tests, and `.claude/skills/rstudio-run-playwright-tests/SKILL.md

loopbackioCLAUDE.md

loopback-next

loopbackio/loopback-next/CLAUDE.md

sandbox/** — For testing monorepo packages as local dependencies - **benchmark/** — Performance benchmarks - **docs/** — Jekyll-based documentation site Managed with **Lerna** (independent versioning) and **npm workspaces**. ## Build & Development Commands ```bash # Install dependencies

No other project uses it yet

PeonPingPipes a download into a shellCLAUDE.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