Boas prticas de Code Review para bons programadores

O Code Review deve ser um processo natural dentro do fluxo de desenvolvimento. Esse processo ajuda a identificar bugs e m implementaes antes da fase de teste e validao.

O resultado uma base de cdigo mais estvel e de maior qualidade. Outro benefcio de realizar code review de um parceiro reforar as relaes pessoais e o senso de trabalho em equipe. O processo de reviso permite tambm uma distribuio do conhecimento tcnico e compreenso dos processos entre o time.

Boas prticas na hora de revisar o cdigo

O primeiro aspecto de um bom code review se atentar ao lado humano antes do cdigo. Abaixo segue uma lista de condutas para se atentar quando revisar o cdigo de outra pessoa:

Revisor

• Como revisor, voc deve pensar como outra pessoa.

• Ao apontar sugestes, tente formular frases a partir de um ponto de vista mais pessoal
  
  ex: "Eu sugiro que...", "Eu acho...", "Para mim, esse ponto..."

• Sempre, SEMPRE a reviso sobre o cdigo, nunca sobre o autor.
  
  ex: "Voc est fazendo uma implementao errada ..."
  " O cdigo est fazendo uma implementao errada..."

• Faa perguntas de pontos que no ficaram claros, ou oferea sugestes atravs de perguntas. Por meio das respostas, podemos entender melhor a deciso para certo ponto do cdigo.

• Faa comentrios atravs Observaes, Impactos e Requisies

  ex: Observao "Essa implementao repetida em outro contexto, poderia ser reutilizada"
  Impacto "Essa implementao torna a compreenso do real objetivo do mtodo no to claro para mim"
  Request " Para esse cenrio eu sugiro usar X padro de projeto, por N motivos"

• Entenda que existem diferentes solues para o mesmo problema.

• Distinguir entre boas prticas e gosto pessoal

• Faa elogios ao cdigo quando necessrio, mesmo que precise de algum ajuste.

• Se pergunte sempre se sua afirmao verdadeira, se necessria e se gentil.

• Valorize o esforo que o autor teve em escrever o cdigo

Autor

• Como autor, voc deve ter humildade para ouvir sobre o seu trabalho
• normal acontecer falhas, ou ter implementaes melhores, ou esquecermos de algum detalhe
• Lembre-se que um cdigo escrito em 10 horas revisado em 10 minutos
• No leve as crticas para o lado pessoal, voc no o seu cdigo
• Voc e o revisor esto no mesmo time
• Somos sempre enviesados pelo nosso prprio cdigo. Esteja aberto a opinies externas

Cdigo

Ao revisar um cdigo bom ter um checklist do que precisa ser avaliado. Conferir todos aspectos do cdigo de uma vez pode ser exaustivo e propenso a falhas. bom atentar-se a um tpico e validar todo contedo sob aquela tica.

• [ ] Eu entendo o que o cdigo faz?

• [ ] O cdigo preenche todos os requisitos de implementao?

• [ ] O cdigo faz o que eu espero que ele faa?

• Usando templates para Pull Requests, fica fcil analisar o que aquela PR deve resolver

• A descrio da PR/commit est de acordo com o que o cdigo executa?

• Ateno a sintaxe, no tem nenhum code smells ?

• Ateno se foi feito um tratamento de execees

• Ateo ao uso correto dos design patters e a over-engineer

Detalhes e referncias:

• Code Review Guidelines for Humans
• How to Make Good Code Reviews Better
• Best Practices for Code Review
• A Guide to Effective Pull Request Reviews