Zum Hauptinhalt springen

CLAUDE.md-Startvorlagen

Alle Level

CLAUDE.md ist das Wirkungsvollste, was du Claude Code mitgeben kannst: dauerhafte Anweisungen, die es in jeder Sitzung liest. Lege eine davon in das Wurzelverzeichnis deines Repos (oder führe /init aus, um einen Ausgangspunkt zu erzeugen) und kürze sie dann passend. Nutze den Kopier-Button bei jedem Block.

:::tip Halte sie kurz und wahrheitsgetreu Eine CLAUDE.md, die lang, wunschdenkerisch oder veraltet ist, schadet — Claude folgt ihr wörtlich. Beschreibe, wie das Projekt tatsächlich funktioniert, und kürze rücksichtslos. Details auf der CLAUDE.md-Seite. :::

Universelle Startvorlage​

# 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-Webanwendung​

# 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-Service​

# 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.

Tipps, die für alle gelten​

  • Schichte sie. Eine CLAUDE.md im Repo-Wurzelverzeichnis für das gesamte Projekt; verschachtelte CLAUDE.md-Dateien in Unterordnern für bereichsspezifische Regeln.
  • Nutze @imports, um vorhandene Dokumente einzubinden, statt sie zu duplizieren (siehe die CLAUDE.md-Referenz).
  • Überprüfe sie monatlich. Veraltete Anweisungen sind schlimmer als gar keine.

Verwandtes​