Code review: tenha empatia e seja aberto às críticas

Code review é muito mais que uma prática, é uma forma de trocar conhecimento, contribuir com o crescimento do time e de melhorar gradativamente a qualidade do software.

Ao longo do desenvolvimento de um software é comum que os desenvolvedores estejam imersos em linhas de códigos, em resoluções de problemas e em tasks e mais tasks, e claro, no meio desse processo de codificação é possível cometer erros a nível de desenvolvimento, ou porque saiu do padrão do projeto ou até mesmo porque implementou um trecho de código amarrado, que poderia gerar gargalos para os devs do futuro.

E afinal de contas, como o code review pode ajudar com esses problemas?

Bom, como o próprio nome já diz, é uma revisão do código, inicialmente o desenvolvedor faz suas modificações e em seguida faz o commit das mesmas, assim, outro desenvolvedor pode fazer observações e propor melhorias através do pull request. Em linhas gerais, é o momento que seu código será revisado por outro desenvolvedor que identificará os problemas que podem passar despercebidos e sugerir formas de resolvê-los.

Importante lembrar:

O code review não é apontar qualquer erro ou detalhe irrelevante, pois você deve pensar em como melhorar a qualidade do código a nível de otimização e sempre visando aprimorar a forma como foi resolvido pelo colega e, claro, é nesse momento que ocorre a troca, o compartilhamento e a oportunidade de crescimento técnico do time.

Abaixo, alguns pontos importantes sobre code review:

Faça commits bem descritos

Para início de conversa, essa etapa é crucial para que se tenha um histórico do que foi desenvolvido. Em um cenário onde temos logs mal descritos ficará difícil relembrar o motivo de certas implementações, vejamos o commit abaixo:

Exemplo 1:

Correção do erro no modal

Alterando a abordagem anterior:

Exemplo 2:

Correção no bug do modal que impedia de fechá-lo

- Em razão do motivo XY foi necessário realizar ABC para correção do problema que bloqueava o modal de fechar

- Foi ajustado o estilo do modal

Logo que abrir um pull request segundo o exemplo 2, a primeira linha é o título do commit e as demais serão as descrições do commit.

É possível notar a grande diferença entre o primeiro e o segundo commit, pois o segundo torna o processo de entendimento e de revisão mais rápido, uma vez que os commits estão bem organizados.

É hora de descentralizar o conhecimento!

Bom, entendemos que o code review ajuda no compartilhamento de conhecimento, e uma vez que todos ficam responsáveis pela revisão, o time todo passa a conhecer o código do sistema. Portanto, essa familiaridade do código pelos membros do time faz com que o conhecimento não fique retido somente em um desenvolvedor, logo, torna possível o prosseguimento da codificação sem criar dependências técnicas.

Saiba como fazer um review

Em uma equipe de desenvolvedores, geralmente tem-se variados níveis de conhecimento e, durante as interações para um code review, é importante comunicar da melhor forma o apontamento que se queira fazer, deixar claro se a observação é uma melhoria ou um aprimoramento da forma como foi solucionada ou até mesmo se foi por preferência pessoal.

Use frases como: “Acredito que nesse trecho poderia ser usado XYZ por motivo de diminuir o tempo de ABC, o que você acha?” e claro, sempre buscando ter empatia e trocando conhecimento com o colega. E quando trata-se de uma alternativa, é importante deixar claro que o colega não deve ser obrigado a segui-la, só quando o time realmente ver a necessidade de melhorar uma implementação que pode gerar problemas futuros.

Saiba como receber um review

A todo o momento nós, enquanto desenvolvedores, estamos aprendendo e melhorando todos os dias e, para isso, é necessário errar muito para aprender muito! E quando se fala em code review, não é diferente, pois nesse momento é importante enxergar por outras percepções e ser compreensível acerca do que o outro está apontando.

Se a melhoria foi desenvolvida em um novo commit, adicione no comentário a hash do commit:

Alterei o nome da classe para “container-nav” [a100w9e]

E ao receber um review do seu código, agradeça as propostas de melhoria: “Boa, não sabia que tinha essa forma de fazer, vou verificar”. E antes de solicitar o review faça você mesmo um review do seu código.

Conclusão

Portanto, code review é uma prática que gera de fato valor para o time, aumentando a colaboração, compartilhamento e produtividade, logo é importante atentar-se na elaboração de bons commits, em comentários relevantes nos PRs e claro, estar aberto às críticas recebidas do seu trabalho.

Ao final do code review, será possível gerar mais aprendizado tanto para o dev que teve o código revisado, quanto para o revisor, tornando possível a integração do time.

Autores

Pamela Otéro, Software Engineer — Unidade de Negócio Canal Físico Farma — Bemol Digital.

Hallison Batista, Software Engineer — Unidade de Negócio Canal Físico Farma — Bemol Digital

Referências

https://www.campuscode.com.br/conteudos/guia-para-dar-e-receber-um-bom-code-review

https://ezdevs.com.br/qual-e-o-papel-do-code-review-e-qual-o-ganho-para-a-empresa/

https://imasters.com.br/desenvolvimento/code-review-comunicacao-amigavel-e-cultura/?trace=1519021197&source=single

https://alexrosa.net/code-review-e-seguranca-da-informacao/

https://startecjobs.com/artigos/carreira/code-review-o-que-e/

https://safewayconsultoria.com/o-que-e-code-review-saiba-a-importancia-de-fazer-essa-revisao/