O processo de code review é muito realizado em projetos de software que possuem uma estrutura mínima de qualidade. Esse procedimento consiste em, após uma pessoa desenvolvedora terminar uma tarefa e gerar um pull request (PR), outra pessoa desenvolvedora analisará e indicará melhorias para esse código.

Assim, as pessoas desenvolvedoras atuam na melhoria do código do time, aumentando o nível de qualidade do código e evitando possíveis bugs. Além disso, contribuindo para o aperfeiçoamento das habilidades técnicas e nivelando o time.

6 Boas práticas para executar no code review

1. Use emoticons apenas para demonstrar aprovação, por exemplo 👍🏽 , ✅, 🚀, 😊.

2. Não refatore o PR de outra pessoa sem que ela saiba. Caso sejam necessárias muitas modificações, realize comentários. Refatorar sem informar, retira a oportunidade de aprendizado da pessoa desenvolvedora.

3. Prefira explicar suas sugestões com pequenos pedaços de código ou links que direcionem a pessoa desenvolvedora.

4. Sempre que possível responda os comentários no PR. Habilitar a configuração para enviar alerta de novos comentários para o seu e-mail, pode ser uma ótima prática.

5. Prefira usar linguagem sugestiva à imperativa. Outra boa opção, é utilizar perguntas, por exemplo:

Exemplo 1

❌ ” Ficou ruim ”

✔️ ” É uma ótima prática utilizar nomes mais descritivos. Sugestão: isFlowStateFinished”.

Exemplo 2

❌ ” Nada disso ficou bom”

✔️ ” É mais interessante utilizarmos o padrão do MVC. Você consegue perceber as melhorias associadas? Podemos conversar melhor sobre 😄 ”.

Exemplo 3

❌ ” Esse for está com uma performance ruim”

✔️ ” Utilizar um find() poderia gerar uma performance melhor nesse trecho de código”.

1. Em PRs maiores ou mais difíceis dê parabéns, ou envie uma mensagem positiva, na aprovação do PR. Trabalhar com desenvolvimento normalmente não é fácil, o incentivo dos colegas é uma prática bem positiva. Apesar de parecer simples, essa prática ajuda na manutenção da cultura e clima.

Curtiu as dicas?

Comenta aqui se você utiliza outras práticas interessantes no code review 😄