- 🐛 Correção de bug (mudança que corrige um problema)
- ✨ Nova funcionalidade (mudança que adiciona funcionalidade)
- 💥 Breaking change (correção ou funcionalidade que causa quebra de compatibilidade)
- 📝 Documentação (mudanças apenas em documentação)
- ♻️ Refatoração (mudança que não corrige bug nem adiciona funcionalidade)
- ⚡ Performance (mudança que melhora performance)
- ✅ Testes (adiciona ou corrige testes)
- 🔧 Configuração (mudanças em configuração ou build)
- ✅ Não remove campos de respostas de API existentes
- ✅ Não renomeia campos de respostas de API existentes
- ✅ Não muda tipos de dados de campos existentes (string → number, etc.)
- ✅ Não muda o formato de URLs de endpoints existentes
- ✅ Não muda códigos de status HTTP de endpoints existentes
- ✅ Se fez mudanças incompatíveis, criei uma nova versão (v2, v3, etc.)
- ✅ Atualizei ou criei documentação OpenAPI em
/pages/docs/doc/ - ✅ Documentação inclui exemplos de requisição e resposta
- ✅ Documentação está em português
- ✅ Atualizei README.md se necessário
- ✅ N/A - Mudanças não requerem documentação
- ✅ Criei ou atualizei testes E2E
- ✅ Todos os testes passam localmente (
npm test) - ✅ Teste de CORS funciona corretamente
- ✅ Testei casos de erro (404, 400, 500, etc.)
- ✅ Testei casos de sucesso
- ✅ N/A - Mudanças não requerem testes
- ✅ Código segue os padrões do projeto (ESLint + Prettier)
- ✅ Executei
npm run fixantes de commitar - ✅ Não adicionei dependências desnecessárias ou pesadas
- ✅ Código não expõe credenciais ou informações sensíveis
- ✅ Validei todos os inputs de usuário
- ✅ Tratei erros apropriadamente
- ✅ Usei Conventional Commits
- ✅ Não adicionei processamento pesado que aumenta custos
- ✅ Usei cache quando apropriado
- ✅ Minimizei chamadas a APIs externas
- ✅ Considerei impacto em rate limits de APIs externas
- ✅ Testei performance em casos de alto volume
Pontos de Atenção Críticos:
- Compatibilidade: Verifique se há quebra de contrato de API
- Documentação: Confirme que está atualizada e completa
- Testes: Valide cobertura de casos de sucesso e erro
- Performance: Avalie impacto em custos e velocidade
- Segurança: Verifique validação de inputs e exposição de dados
Lembre-se: BrasilAPI serve milhares de desenvolvedores e empresas importantes. Mudanças devem ser cuidadosamente avaliadas para garantir confiabilidade e zero downtime.