CLAUDE.md examples from real projects

zenml-ioReads credentialsCLAUDE.md

zenml

zenml-io/zenml/.github/CLAUDE.md

ZenML GitHub Actions Guidelines This document provides guidance for AI assistants working with ZenML's GitHub Actions workflows. ## Workflow Organization ### Categories | Category | Workflows | Purpose | |----------|-----------|---------| | **CI/Testing** | ci-fast.yml, ci-slow.yml, unit-test.yml, integration-test

weave-osCLAUDE.md

router

weave-os/router/CLAUDE.md

swallow; don't log-and-continue on request path. The one documented exception is a **best-effort, off-request-path fire-and-forget** — always wrapped in [`observability.SafeGo`](internal/observability/safego.go) (bounded timeout

nyblnetCLAUDE.md

bento

nyblnet/bento/CLAUDE.md

Bento — self-contained office documents One HTML file = the document + viewer + editor. See `README.md` for the vision. `slides/` is the first app (PowerPoint replacement); **Bento Spaces** (Notion/notes-like) and **Bento Dash

No other project uses it yet

orion-libCLAUDE.md

OrionTV

orion-lib/OrionTV/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

useplunkReads credentialsCLAUDE.md

plunk

useplunk/plunk/CLAUDE.md

Main platform (next-app.useplunk.com) - **landing**: Next.js app (Pages Router) - Marketing site (www.useplunk.com) - **wiki**: Next.js app - Documentation site (docs.useplunk.com) ### Background Job Architecture The API uses BullMQ (backed by Redis) for asynchronous

prettierCLAUDE.md

prettier-vscode

prettier/prettier-vscode/CLAUDE.md

ModuleResolver`, `PrettierEditService`, and `StatusBar` - Registers formatting commands and disposables **PrettierEditService** (`src/PrettierEditService.ts`): - Registers VS Code document formatting providers - Handles format document/selection requests - Watches for config file changes (`.prettierrc`, `package.json`, etc.) - Builds

aaddrickDeletes or force-pushesCLAUDE.md

claude-desktop-debian

aaddrick/claude-desktop-debian/CLAUDE.md

Claude Desktop Debian - Development Notes ## Required reading These documents are the source of truth. If anything in this file conflicts with them, they win. Read them before opening

Live-ChartsCLAUDE.md

LiveCharts2

Live-Charts/LiveCharts2/CLAUDE.md

same file (only when related by inheritance). This is required for automatic documentation generation. ## Key Constraints - **Never add platform-specific code to `LiveChartsCore`** — it must remain platform-agnostic - **.NET Framework

hey-apiCLAUDE.md

openapi-ts

hey-api/openapi-ts/CLAUDE.md

code: - **Preserve all JSDoc comments** - Read the original file first and keep all existing documentation - **Match existing code patterns** - Look at similar files in the codebase for conventions - **Prefer `edit

chakra-uiCLAUDE.md

ark

chakra-ui/ark/CLAUDE.md

Built on top of Zag.js state machines, it provides unstyled, accessible UI components. ## Documentation Structure This guide is split into focused documents for better navigation: - **[Overview](@.claude/docs/overview.md)** - Project overview, architecture

No other project uses it yet

0xebCLAUDE.md

TheBigPromptLibrary

0xeb/TheBigPromptLibrary/.claude/CLAUDE.md

custom GPT instructions, jailbreak prompts, and instruction protection techniques. The content is primarily markdown documentation for educational purposes around prompt engineering and LLM security research. ## Repository Structure - **SystemPrompts/** - System prompts

trustwalletCLAUDE.md

assets

trustwallet/assets/CLAUDE.md

Knowledge Scope This repo's `knowledge/` covers: **ci, code-conventions, patterns, specs** Topics NOT documented locally: architecture, build, conventions, core-libs, decisions, design, features, git-conventions, guides, observability, product, quality

leitsCLAUDE.md

MeetingBar

leits/MeetingBar/CLAUDE.md

docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) and [docs/TESTING.md](docs/TESTING.md) for implementation and verification details. Do not duplicate these documents here

unicity-sphereReads credentialsCLAUDE.md

sphere-sdk

unicity-sphere/sphere-sdk/CLAUDE.md

# CLAUDE.md - Sphere SDK Project Context This file provides context for Claude Code when working

digitallyinducedDeletes or force-pushesCLAUDE.md

ihp

digitallyinduced/ihp/CLAUDE.md

ihp.url = .*|ihp.url = \"path://$(pwd)\";|" ../flake.nix direnv allow cd .. nix flake update ``` ## Documentation The `/Guide/` directory contains comprehensive documentation in markdown. Run `devenv up` from the Guide directory to preview changes

No other project uses it yet

breaking-brakeCLAUDE.md

cc-wf-studio

breaking-brake/cc-wf-studio/CLAUDE.md

patch version bump) - `improvement:` - Minor enhancement to existing feature (patch version bump) - `docs:` - Documentation only - `refactor:` - Code refactoring - `chore:` - Build/tooling changes #### What to Avoid ❌ Long explanations (Problem/Solution/Impact sections) ❌ Multiple paragraphs

No other project uses it yet

tagspacesReads credentialsCLAUDE.md

tagspaces

tagspaces/tagspaces/CLAUDE.md

leading `/` (e.g., `/Users/username/Documents/`) - **Windows local**: Drive-letter paths with `\` separators (e.g., `C:\Users\username\Documents\`). Java `.properties` files treat `\` as escape characters — always convert to `/` when writing paths to config

kasmtechDeletes or force-pushesCLAUDE.md

KasmVNC

kasmtech/KasmVNC/CLAUDE.md

spec compliance** — divergence is intended. (A detailed list of the deviations is not yet documented here; see `PLAN.md`. When in doubt, ask rather than reverting to standard VNC behavior.) - **Modern

conorbronsdonCLAUDE.md

avoid-ai-writing

conorbronsdon/avoid-ai-writing/CLAUDE.md

examples exempt from flagging) must be preserved — without it the skill flags its own documentation - Technical-blog profile has explicit word table exceptions (e.g., "robust" and "ecosystem" are legitimate

No other project uses it yet

lukevellaReads credentialsCLAUDE.md

rallly

lukevella/rallly/CLAUDE.md

with dev scripts) ``` ## Architecture ### Monorepo Structure - `apps/web/` - Main Next.js application - `apps/landing/` - Marketing/landing page - `apps/docs/` - Documentation site - `packages/` - Shared packages: - `database/` - Prisma schema and client - `ui/` - Shared UI components - `emails/` - Email