KOLOS — Padrão de Documentação (Doc-First)
Contexto
O KOLOS segue “Doc-First”: mudanças precisam ser rastreáveis e reproduzíveis. Sem um padrão, é comum faltar:
- Rotas/URLs/nomes
- Regras de acesso (roles/permissions/policies)
- Passos de validação reais
Decisão
Adotar um padrão mínimo para qualquer mudança que altere comportamento, infraestrutura, rotas, ou acesso.
Padrão mínimo (obrigatório)
Para cada mudança em docs/changes/YYYY-MM-DD_slug.md:
- Contexto: qual problema/risco/requisito motivou.
- Decisão: o que foi escolhido + alternativa descartada (quando relevante).
- Rotas e Acesso (quando aplicável):
METHOD /path + route name
- Middlewares (
auth, guest, role:*, etc.)
- Policies/Gates (
authorize(...), @can, etc.)
- Commands / Jobs / Eventos (quando aplicável): assinatura e propósito.
- Passos: comandos (sempre com
sail) e fluxos manuais.
- Validação: como provar que funciona (tests/URLs/logs).
- Impacto: arquivos alterados e efeitos colaterais conhecidos.
Convenções
- Rotas novas/alteradas devem ser registradas também em
docs/architecture/kolos_registro-de-rotas.md.
- Se a mudança afeta permissões/policies, incluir:
- permissão (
venue.manage_courts etc.)
- regra de escopo/tenancy (ex.: dono da arena)
- testes cobrindo allow/deny
- Preferir textos curtos, objetivos, reproduzíveis.
Checklist rápido