A revisão de código é um processo importante do desenvolvimento de software. Outras pessoas olhando para o código ajudam a identificar falhas que passaram desapercebidas ou melhorias que poderiam ser implementadas.
Code review do GitHub
Segue uma lista de itens que considero importantes e me guio ao fazer uma revisão de código:
Testes Link to heading
- Todos os testes estão passando? (O ideal é que os testes rodem automaticamente via alguma ferramenta de automação)
- Foram adicionados testes referente ao código modificado?
- A cobertura de testes está satisfatória?
Simplicidade e Legibilidade Link to heading
- O código está simples e fácil de entender?
- O código está organizado?
Alteração nos modelos Link to heading
Se o projeto possui modelos que se comunicam com um banco de dados:
- Esses modelos foram alterados?
- As modificações não irão quebrar a aplicação quando subir para outros ambientes?
- Foram criadas as migrações necessárias?
Documentação Link to heading
- O código alterado modifica algum comportamento que deveria ser documentado?
- Alguma docstring deveria ser alterada?
Conflitos Link to heading
- Tem algum conflito do git a ser resolvido?
Ambientes Link to heading
- O ambiente que o código está indo necessita alguma modificação?
- Alguma variável deve ser adicionada ao ambiente?
Concorda? Discorda? Tem algo a acrescentar ou remover? Deixe nos comentários.