TemplatesProject
CLAUDE.md — {{NOMEDOPROJETO}}
Instruções para ferramentas de IA (Claude, Cursor, ChatGPT) que trabalham neste repositório.
2 min de leitura
Template pronto para copiar ou baixar
Instruções para ferramentas de IA (Claude, Cursor, ChatGPT) que trabalham neste repositório.
Este projeto segue os padrões da AEX Engineering. Em caso de conflito, prevalece o padrão oficial da engenharia.
Identidade do projeto
- O que é: {{DESCRICAO_CURTA}}
- Problema que resolve: {{PROBLEMA}}
- Estágio: {{ESTAGIO}}
Stack
- Linguagem/Framework: {{LINGUAGEM_FRAMEWORK}}
- Banco de dados: {{BANCO_DE_DADOS}}
- Infraestrutura: {{INFRAESTRUTURA}}
- Outros: {{OUTROS_SERVICOS}}
Comandos essenciais
{{COMANDO_RODAR}} # rodar localmente — (exemplo) docker compose up
{{COMANDO_TESTES}} # rodar os testes — (exemplo) npm test
{{COMANDO_BUILD}} # build de produção — (exemplo) npm run buildConvenções
- Escreva código legível e simples — a solução mais simples que resolve vence.
- Commits seguem Conventional Commits (ver COMMIT_STANDARD da engenharia).
- Branches seguem o padrão de branches (
feature/,fix/,hotfix/,release/). - {{CONVENCAO_ESPECIFICA}}
Estrutura
src/— {{DESCRICAO_SRC}}docs/— documentação técnica (PRD, ARCHITECTURE, API, DATABASE, DEPLOY, etc.).docker/— configurações de containers.
Documentação de referência
Leia sob demanda antes de agir:
- Contexto de negócio →
PROJECT_CONTEXT.md - Requisitos →
docs/PRD.md - Arquitetura e decisões →
docs/ARCHITECTURE.mdedocs/DECISIONS.md - Contrato da API →
docs/API.md - Modelo de dados →
docs/DATABASE.md
Nunca faça (guardrails)
- Não commite segredos, credenciais ou
.envreais — use apenas.env.example. - Não altere o comportamento sem atualizar a documentação afetada no mesmo PR.
- Não introduza dependências ou serviços sem registrar a decisão em
docs/DECISIONS.md. - {{GUARDRAIL_ESPECIFICO}}
- Em caso de dúvida ou conflito de regras, pergunte antes de assumir.