Pular para o conteúdo principal

Modelos Iniciais de CLAUDE.md

Todos os níveis

CLAUDE.md é a coisa de maior alavancagem que você pode dar ao Claude Code: instruções persistentes que ele lê a cada sessão. Coloque um destes na raiz do seu repositório (ou execute /init para gerar um ponto de partida), depois ajuste-o para se adequar. Use o botão de copiar em cada bloco.

:::tip Mantenha-o curto e verdadeiro Um CLAUDE.md longo, aspiracional ou desatualizado prejudica — o Claude o segue literalmente. Descreva como o projeto realmente funciona e remova sem dó. Detalhes na página do CLAUDE.md. :::

Modelo inicial universal​

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

Aplicação web 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.

Serviço 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.

Dicas que se aplicam a todos eles​

  • Estruture em camadas. Um CLAUDE.md na raiz do repositório para o projeto inteiro; arquivos CLAUDE.md aninhados em subpastas para regras específicas de cada área.
  • Use @imports para puxar documentos existentes em vez de duplicá-los (veja a referência do CLAUDE.md).
  • Revise-o mensalmente. Instruções obsoletas são piores do que nenhuma.

Relacionado​