agentleFS

CLAUDE.md examples from real projects

How real projects brief Claude Code: the commands, conventions and warnings they put in CLAUDE.md.

Best matches · from page 9Worked for most · soon
phpstanCLAUDE.md

phpstan / website

phpstan/phpstan/website/CLAUDE.md

global data files - `src/_posts/` — Blog posts (Markdown) - `src/js/` — TypeScript source files - `src/user-guide/` — User guide documentation (Markdown) - `src/developing-extensions/` — Extension development docs - `src/writing-php-code/` — PHP writing guide - `src/app.pcss` — Main stylesheet (Tailwind + custom

14k9mo agoReviewMountCreate a free account to mount
567-labsCLAUDE.md

instructor

567-labs/instructor/CLAUDE.md

coverage run -m pytest tests/ -k "not docs"` then `uv run coverage report` - Build documentation: `uv run mkdocs serve` (for local preview) or `./build_mkdocs.sh` (for production) - Waiting: use `sleep

Steady5 mentions in 2 weeks

No other project uses it yet

14k6mo agoReviewMountCreate a free account to mount
borgbackupCLAUDE.md

borg

borgbackup/borg/.claude/CLAUDE.md

Always write pytest-style tests unless unittest-style is explicitly required. ## Writing docstrings, comments, documentation The docs shall always be in sync with the current code, algorithms and data structures

No other project uses it yet

14k13d agoReviewMountCreate a free account to mount
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

14k17mo agoReviewMountCreate a free account to mount
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

Steady4 mentions in 2 weeks

1 project uses a version of this

14k14mo agoReviewMountCreate a free account to mount
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

13k10mo agoReviewMountCreate a free account to mount
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

Steady3 mentions in 2 weeks

No other project uses it yet

13k8mo agoReviewMountCreate a free account to mount
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

13k1d agoReviewMountCreate a free account to mount
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

13k6mo agoReviewMountCreate a free account to mount
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

12k11d agoReviewMountCreate a free account to mount
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

Steady5 mentions in 2 weeks

No other project uses it yet

12k3mo agoReviewMountCreate a free account to mount
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

12k3mo agoReviewMountCreate a free account to mount
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

12k11mo agoReviewMountCreate a free account to mount
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

12k10mo agoReviewMountCreate a free account to mount
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

Steady6 mentions in 2 weeks

No other project uses it yet

12k9d agoReviewMountCreate a free account to mount
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

11k11mo agoReviewMountCreate a free account to mount
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

Steady12 mentions in 2 weeks

No other project uses it yet

11k8mo agoReviewMountCreate a free account to mount
gui-csCLAUDE.md

Terminal.Gui

gui-cs/Terminal.Gui/CLAUDE.md

graphemes** - `GetColumns()`, `GraphemeHelper.GetGraphemes()` - `cwp-pattern.md` - Cancellable Workflow Pattern - `code-layout.md` - Backing fields, member ordering - `api-documentation.md` - XML documentation requirements - `testing-patterns.md` - Test patterns and requirements - `logging-tracing.md` - **No Console.WriteLine** - use Logging/TestLogging/Trace - `fragile-areas.md` - Code that must

11k6mo agoReviewMountCreate a free account to mount
tambo-aiCLAUDE.md

tambo

tambo-ai/tambo/docs/CLAUDE.md

architectural guidance and content workflows.** ## Quick Reference The Docs package (`@tambo-ai/docs`) - Next.js documentation site built with Fumadocs

11k5mo agoReviewMountCreate a free account to mount
pwndbgCLAUDE.md

pwndbg

pwndbg/pwndbg/CLAUDE.md

both GDB (mature, battle-tested) and LLDB (experimental, early-stage). **Important**: Read the developer documentation in `docs/contributing/` for comprehensive guidance. This file highlights critical information for AI-assisted development. ## Quick

11k2y agoReviewMountCreate a free account to mount
CLAUDE.md vs AGENTS.md

About CLAUDE.md

What is CLAUDE.md?

A file Claude Code reads at the start of every session. It holds the commands, conventions and warnings the agent needs for this project.

Where does it go?

At the repository root. Claude Code also reads CLAUDE.md files in subdirectories when it works there.

What should it contain?

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.md or AGENTS.md?

Claude Code reads CLAUDE.md; most other agents read AGENTS.md. Many projects keep one and point the other at it.