Перейти к основному содержимому

Стартовые шаблоны CLAUDE.md

Все уровни

CLAUDE.md — это самое мощное, что вы можете дать Claude Code: постоянные инструкции, которые он читает в каждой сессии. Положите один из этих файлов в корень репозитория (или запустите /init, чтобы сгенерировать отправную точку), а затем подгоните под себя. Используйте кнопку копирования на каждом блоке.

:::tip Держите его коротким и правдивым Длинный, мечтательный или устаревший CLAUDE.md вредит — Claude следует ему буквально. Описывайте, как проект работает на самом деле, и безжалостно сокращайте. Подробности — на странице CLAUDE.md. :::

Универсальный стартовый шаблон​

# Project: <name>

## What this is
<One or two sentences: what the project does and who uses it.>

## Tech stack
- Language/runtime: <e.g. TypeScript, Node 20>
- Framework: <e.g. Next.js 14 App Router>
- Key libraries: <e.g. Prisma, tRPC, Tailwind>

## How to run
- Install: `<cmd>`
- Dev server: `<cmd>`
- Tests: `<cmd>`
- Lint/format: `<cmd>`

## Conventions
- <e.g. Use functional components; no class components.>
- <e.g. Co-locate tests as *.test.ts next to source.>
- <e.g. Conventional Commits for messages.>

## Guardrails
- Run the tests before saying a task is done.
- Don't edit files under `/generated` or `/vendor`.
- Never commit secrets or .env files.

## Good to know
- <Gotchas, non-obvious decisions, links to deeper docs.>

Веб-приложение на Node / TypeScript​

# Project: <name> (Next.js + TypeScript)

## How to run
- Dev: `npm run dev`
- Build: `npm run build`
- Test: `npm test`
- Lint: `npm run lint` (must pass before commit)

## Conventions
- TypeScript strict; no `any` without a comment justifying it.
- Components in `src/components`, one folder per component.
- Data fetching via tRPC; never call the DB from a client component.
- Styling: Tailwind utility classes; no inline styles.

## Guardrails
- After any change, run `npm run lint && npm test`.
- Keep files under ~300 lines; split when larger.
- Do not modify `prisma/migrations` by hand.

Сервис на Python​

# Project: <name> (FastAPI)

## How to run
- Install: `uv sync` (or `pip install -e .`)
- Dev: `uvicorn app.main:app --reload`
- Test: `pytest`
- Lint/format: `ruff check . && ruff format .`

## Conventions
- Type hints everywhere; prefer `pathlib` over `os.path`.
- Pydantic models for all request/response bodies.
- f-strings, not %-formatting.

## Guardrails
- Run `pytest` and `ruff check` before completing a task.
- Fail fast with descriptive errors; no silent excepts.

Советы, применимые ко всем шаблонам​

  • Слоистость. CLAUDE.md в корне репозитория для всего проекта; вложенные файлы CLAUDE.md в подпапках для правил, специфичных для конкретной области.
  • Используйте @imports, чтобы подтягивать существующую документацию вместо её дублирования (см. справочник по CLAUDE.md).
  • Пересматривайте его ежемесячно. Устаревшие инструкции хуже, чем их отсутствие.

Связанное​