Checklist de Revisão de Código

Visão Geral

Forneça um checklist sistemático para realizar revisões de código completas. Essa habilidade ajuda os revisores a garantir a qualidade do código, identificar bugs, detectar problemas de segurança e manter a consistência em toda a base de código.

Quando Usar Esta Habilidade

• Use ao revisar pull requests
• Use ao realizar auditorias de código
• Use ao estabelecer padrões de revisão de código para uma equipe
• Use ao treinar novos desenvolvedores em práticas de revisão de código
• Use quando quiser garantir que nada seja esquecido nas revisões
• Use ao criar documentação de revisão de código

Como Funciona

Etapa 1: Entenda o Contexto

Antes de revisar o código, vou te ajudar a entender:

• Que problema este código resolve?
• Quais são os requisitos?
• Quais arquivos foram alterados e por quê?
• Existem issues ou tickets relacionados?
• Qual é a estratégia de testes?

Etapa 2: Revise a Funcionalidade

Verifique se o código funciona corretamente:

• Ele resolve o problema declarado?
• Casos extremos são tratados?
• O tratamento de erros é apropriado?
• Existem erros lógicos?
• Ele atende aos requisitos?

Etapa 3: Revise a Qualidade do Código

Avalie a manutenibilidade do código:

• O código é legível e claro?
• Os nomes são descritivos?
• Ele está estruturado adequadamente?
• Funções/métodos são focados?
• Existe complexidade desnecessária?

Etapa 4: Revise a Segurança

Verifique problemas de segurança:

• As entradas são validadas?
• Dados sensíveis são protegidos?
• Existem riscos de injeção de SQL?
• Autenticação/autorização estão corretas?
• As dependências são seguras?

Etapa 5: Revise o Desempenho

Procure por problemas de desempenho:

• Existem loops desnecessários?
• O acesso ao banco de dados é otimizado?
• Existem vazamentos de memória?
• O cache é usado apropriadamente?
• Existem problemas de consulta N+1?

Etapa 6: Revise os Testes

Verifique a cobertura de testes:

• Existem testes para o novo código?
• Os testes cobrem casos extremos?
• Os testes são significativos?
• Todos os testes passam?
• A cobertura de testes é adequada?

Exemplos

Exemplo 1: Checklist de Revisão de Funcionalidade

## Functionality Review

### Requirements
- [ ] Code solves the stated problem
- [ ] All acceptance criteria are met
- [ ] Edge cases are handled
- [ ] Error cases are handled
- [ ] User input is validated

### Logic
- [ ] No logical errors or bugs
- [ ] Conditions are correct (no off-by-one errors)
- [ ] Loops terminate correctly
- [ ] Recursion has proper base cases
- [ ] State management is correct

### Error Handling
- [ ] Errors are caught appropriately
- [ ] Error messages are clear and helpful
- [ ] Errors don't expose sensitive information
- [ ] Failed operations are rolled back
- [ ] Logging is appropriate

### Example Issues to Catch:

**❌ Bad - Missing validation:**
\`\`\`javascript
function createUser(email, password) {
  // No validation!
  return db.users.create({ email, password });
}
\`\`\`

**✅ Good - Proper validation:**
\`\`\`javascript
function createUser(email, password) {
  if (!email || !isValidEmail(email)) {
    throw new Error('Invalid email address');
  }
  if (!password || password.length < 8) {
    throw new Error('Password must be at least 8 characters');
  }
  return db.users.create({ email, password });
}
\`\`\`

Exemplo 2: Checklist de Revisão de Segurança

## Revisão de Segurança

### Validação de Entrada
- [ ] Todas as entradas do usuário são validadas
- [ ] Injeção de SQL é prevenida (use consultas parametrizadas)
- [ ] XSS é prevenido (escape de saída)
- [ ] Proteção CSRF está implementada
- [ ] Uploads de arquivos são validados (tipo, tamanho, conteúdo)

### Autenticação e Autorização
- [ ] Autenticação é exigida onde necessário
- [ ] Verificações de autorização estão presentes
- [ ] Senhas são hasheadas (nunca armazenadas em texto puro)
- [ ] Sessões são gerenciadas de forma segura
- [ ] Tokens expiram apropriadamente

### Proteção de Dados
- [ ] Dados sensíveis são criptografados
- [ ] Chaves de API não são codificadas diretamente no código
- [ ] Variáveis de ambiente são usadas para segredos
- [ ] Dados pessoais seguem regulamentações de privacidade
- [ ] Credenciais de banco de dados são seguras

### Dependências
- [ ] Nenhuma dependência vulnerável conhecida
- [ ] Dependências estão atualizadas
- [ ] Dependências desnecessárias foram removidas
- [ ] Versões de dependências estão fixadas

### Exemplos de Problemas a Detectar:

**❌ Ruim - Risco de injeção de SQL:**
\`\`\`javascript
const query = \`SELECT * FROM users WHERE email = '\${email}'\`;
db.query(query);
\`\`\`

**✅ Bom - Consulta parametrizada:**
\`\`\`javascript
const query = 'SELECT * FROM users WHERE email = $1';
db.query(query, [email]);
\`\`\`

**❌ Ruim - Segredo codificado diretamente no código:**
\`\`\`javascript
const leakedToken = '[chave ativa vazada]';

…