Skip to main content

Processo de Code Review

O Code Review é uma prática essencial para garantir a qualidade do código, promover aprendizado coletivo e manter a consistência do projeto.
Ele consiste na análise do código desenvolvido por um membro do time antes da sua integração à base principal.

Além de melhorar a qualidade técnica, o processo ajuda a compartilhar conhecimento, identificar problemas cedo e aumentar a colaboração entre os desenvolvedores.

Objetivos do Code Review​

  • Garantir a correção e qualidade do código.
  • Melhorar a legibilidade e manutenção da base de código.
  • Promover boas práticas de desenvolvimento.
  • Facilitar o compartilhamento de conhecimento entre os membros do time.
  • Prevenir bugs e falhas de segurança.

Pontos a Observar Durante o Code Review​

1. Correção​

  • O código resolve o problema proposto?
  • Foram considerados casos de exceção e erros possíveis?

2. Clareza e Legibilidade​

  • O código está fácil de entender para outros desenvolvedores?
  • Os nomes de variáveis, funções e classes são descritivos?
  • Existe documentação ou comentários quando necessário?

3. Organização e Estrutura​

  • O código segue a arquitetura e os padrões do projeto?
  • Está devidamente modularizado (sem funções ou classes excessivamente grandes)?
  • Arquivos, pastas e namespaces estão bem organizados?

4. Boas Práticas e Padrões​

  • Está seguindo as convenções de estilo da linguagem, do time e as definições do Desenvolva com Padrões?
  • Evita duplicação de código?
  • Faz uso adequado de testes automatizados?

5. Performance​

  • Há operações desnecessárias ou ineficientes?
  • O algoritmo escolhido é adequado para o problema?

6. Segurança​

  • Dados sensíveis estão sendo tratados de forma segura?
  • Há validação adequada de entradas do usuário?
  • Foram evitadas vulnerabilidades comuns (ex.: SQL Injection, XSS)?

7. Testes​

  • Existem testes cobrindo o código novo ou alterado?
  • Os testes são claros, relevantes e mantêm boa cobertura?

8. Impacto no Sistema​

  • A mudança pode afetar outras partes do sistema?
  • A retrocompatibilidade foi considerada (quando aplicável)?

9. Tratamento de mídias​

  • A mudança trata imagens ou vídeos?
  • Foi levado em consideração a escalabilidade visual da imagem/vídeo?

Boas Práticas no Processo de Review​

  • Seja respeitoso e construtivo nos comentários.
  • Prefira explicar o “porquê” das sugestões em vez de apenas apontar erros.
  • Reconheça pontos positivos no código além de sugerir melhorias.
  • Utilize checklists para padronizar as análises.
  • O objetivo é melhorar o código, não criticar o autor.

Para aprofundar: Code Review Guidelines – Google