O processo de revisão de código começa antes mesmo da revisão, todos devem entender claramente as regras, e concordar com elas, e isso não pode ser alterado durante o processo. Isso inclui, aceitar com antecedentes um estilo de código, configurar ferramentas para fazer as partes chatas como aplicação do estilo, geração de cobertura e etc…
Montando um processo
- Concordar com algo:
- Utilizar um estilo de codificação por exemplo.
- Documenta-lo
- Criar um arquivo de configuração importante
- Para estilo de codificação, pode ser um arquivo que a IDE pode ler e formatar o código.
- Aplica-lo
O tempo do dos desenvolvedores é valioso e caro, devemos focar no que realmente importa, e erros de estilização não devem gastar esse tempo, como solução podemos adotar uma ferramenta que antes do processo de submissão do PR, avalia se o estilo definido está aplicado, e caso contrário, não deixe prosseguir.
Ferramentas de automação podem pegar problemas de:
- Bugs, por exemplo, se um loop é infinito, se a condição booleano é sempre falsa ou verdadeira
- Vulnerabilidade de seguranças
- Code smells
Um exemplo de ferramenta é o SonarLint, disponível para diversas IDEs ttps://www.sonarlint.org/
Podemos também utilizar ferramentas para analisar nosso PR, após sua submissão, como pro exemplo, o SonarQube https://www.sonarqube.org/ .
Quantos revisores o PR deve ter?
Um bom número é dois, porém um deles obrigatoriamente precisar saber as regras de negócios por trás daquele código.
Não existe carteirada durante a revisão.
Um júnior pode ser um revisor de um PR do pleno ou senior. Mesmo com um maior tempo de experiência todos estamos suscetíveis a erros e aprendizado. Mesmo que o PR de um desenvolvedor senior esteja perfeito, a revisão oferece uma oportunidade de orientação e colaboração entra a equipe e como bonus, diversifica a compreensão do código.
Um desenvolvedor senior deve estar preparado para responder as perguntas que para ele, pode parecer obvias, mas para seus companheiros não serão.
Se tem um novo membro na equipe, ele não pode ter medo de deixar comentário sobre coisas que ele acha que devem ser corrigidas, pois cada pequena ajuda conta. Toda a equipe de ser encorajada a corrigir até mesmo os menores problemas, como erros de digitações em comentários por exemplo.
Escolhendo soluções
Ao se deparar com um problema, geralmente temos diversos soluções para a resolução, algumas ruins outras boas. Caso o autor do PR escolha uma solução boa, os revisões precisam saber distinguir as boas práticas comuns, do gosto pessoal, e não forçar o autor a seguir a solução do revisor.
Não deixa uma revisão travada por dias
A revisão deve ser feitos em horas, e não em dias, essa é um convenção importante que todos precisam concordar, pois é responsabilidade de ambas as partes, autor e revisores.
Top comments (0)