Uma pessoa que desenvolve software terá o seu código revisado e revisará o de outras pessoas praticamente todos os dias, e mesmo com essa repetição às vezes esquecemos um ponto ou outro.
Este é um guia com pontos básicos a serem verificados em uma revisão de código, fique à vontade para usar/modificar/melhorar, na sua empresa ou projeto open source.
Para quem solicita
- Escreva boas mensagens de commit (seguir o Conventional Commits é um bom início);
- Revise seu pull request antes de abrí-lo, tenha certeza que você não esqueceu algum debugger ou erro de digitação;
- Deixe seu pull request pequeno, isso o mantém fácil de revisar e menos nocivo ao negócio;
- Garanta que seu pull request passe nos testes, linters e builds, e não tenha conflitos;
- Escreva uma boa descrição;
- Comente no seu próprio pull request caso algum trecho de código não seja óbvio;
- Espere o revisor terminar para começar a corrigir;
- Escolha os revisores corretos (exemplo: alguém que já tenha trabalhado na mesma parte do código);
Para quem revisa
- Seja gentil;
- Seja uma pessoa minuciosa (este documento pode te ajudar);
- Busque contexto. Leia a descrição do pull request, o ticket, verifique até mesmo as telas (se houver);
- Tenha certeza que você separou tempo necessário para entender e fazer a melhor revisão de código que você puder;
- Respeite o contexto. Se um pull request resolve um bug, não peça para a pessoa desenvolvedora refatorar todo o componente, isso pode ser resolvido no futuro;
- Deixe claro que você está fazendo a revisão, comente Revisando ao iniciar, e Revisado ao terminar.
Esse guia é vivo e está em constante evolução 😉
Top comments (0)