lucasfdigital/code-review-checklist

Checklist de Revisão de Código

Checklist de Revisão Rápida

Correção

• [ ] O código faz o que deveria fazer.
• [ ] Casos de borda (edge cases) tratados.
• [ ] Tratamento de erros implementado.
• [ ] Nenhum bug óbvio.

Segurança

• [ ] Entrada validada e higienizada (sanitized).
• [ ] Sem vulnerabilidades de injeção SQL/NoSQL.
• [ ] Sem vulnerabilidades XSS ou CSRF.
• [ ] Sem segredos codificados (hardcoded) ou credenciais sensíveis.
• [ ] Específico de IA: Proteção contra Prompt Injection (se aplicável).
• [ ] Específico de IA: As saídas são higienizadas antes de serem usadas em sinks críticos.

Performance

• [ ] Sem consultas N+1.
• [ ] Sem loops desnecessários.
• [ ] Cache apropriado.
• [ ] Impacto no tamanho do bundle considerado.

Qualidade do Código

• [ ] Nomenclatura clara.
• [ ] DRY - sem código duplicado.
• [ ] Princípios SOLID seguidos.
• [ ] Nível de abstração apropriado.

Testes

• [ ] Testes unitários para o novo código.
• [ ] Casos de borda testados.
• [ ] Testes legíveis e fáceis de manter.

Documentação

• [ ] Lógica complexa comentada.
• [ ] APIs públicas documentadas.
• [ ] README atualizado, se necessário.

Padrões de Revisão de IA e LLM (2025)

Lógica e Alucinações

• [ ] Chain of Thought: A lógica segue um caminho verificável?
• [ ] Casos de Borda: A IA considerou estados vazios, timeouts e falhas parciais?
• [ ] Estado Externo: O código faz suposições seguras sobre sistemas de arquivos ou redes?

Revisão de Prompt Engineering

// ❌ Prompt vago no código
const response = await ai.generate(userInput);

// ✅ Prompt estruturado e seguro
const response = await ai.generate({
  system: "Você é um parser especializado...",
  input: sanitize(userInput),
  schema: ResponseSchema
});

Anti-Padrões para Sinalizar

// ❌ Números mágicos
if (status === 3) { ... }

// ✅ Constantes nomeadas
if (status === Status.ACTIVE) { ... }

// ❌ Aninhamento profundo
if (a) { if (b) { if (c) { ... } } }

// ✅ Retornos antecipados (Early returns)
if (!a) return;
if (!b) return;
if (!c) return;
// executa o trabalho

// ❌ Funções longas (mais de 100 linhas)
// ✅ Funções pequenas e focadas

// ❌ Tipo 'any'
const data: any = ...

// ✅ Tipagem adequada
const data: UserData = ...

Guia de Comentários de Revisão

// Problemas bloqueadores usam 🔴
🔴 BLOQUEADOR: Vulnerabilidade de injeção SQL aqui

// Sugestões importantes usam 🟡
🟡 SUGESTÃO: Considere usar useMemo para melhor performance

// Melhorias menores usam 🟢
🟢 MELHORIA: Prefira const em vez de let para variáveis imutáveis

// Perguntas usam ❓
❓ PERGUNTA: O que acontece se o usuário for nulo aqui?