O que code-review-checklist faz?
Lista de verificação abrangente para realizar revisões de código completas, abrangendo funcionalidade, segurança, desempenho e facilidade de manutenção.
Funcionalidade
- Correção Lógica: O código implementa corretamente a funcionalidade esperada?
- Cobertura de Casos Limite: Foram considerados casos de borda e entradas inválidas?
- Tratamento de Erros: Erros e exceções são tratados adequadamente?
- Validação de Entrada: Dados de entrada são validados e sanitizados?
Segurança
- Vulnerabilidades: O código está livre de vulnerabilidades comuns (ex: SQL injection, XSS)?
- Autenticação e Autorização: Mecanismos de autenticação e autorização estão implementados corretamente?
- Proteção de Dados: Dados sensíveis são protegidos (ex: criptografia, mascaramento)?
- Validação de Saída: A saída é sanitizada para prevenir ataques?
Desempenho
- Eficiência: O código é eficiente em termos de tempo e espaço?
- Uso de Recursos: Recursos (memória, CPU, rede) são utilizados de forma otimizada?
- Consultas ao Banco de Dados: Consultas SQL são eficientes e indexadas?
- Cache: Estratégias de cache são aplicadas quando apropriado?
Facilidade de Manutenção
- Legibilidade: O código é legível e bem documentado?
- Modularidade: O código é modular e segue princípios de design (ex: SOLID)?
- Testabilidade: O código é testável? Testes unitários e de integração estão presentes?
- Padronização: O código segue os padrões de estilo e boas práticas do projeto?
Conclusão
Aplique esta lista de verificação durante suas revisões de código para garantir uma análise abrangente e consistente. Adapte-a conforme necessário para atender às necessidades específicas do seu projeto ou equipe.