DEV Community

Cover image for Guia básico da revisão de código
Lucas Vilaboim
Lucas Vilaboim

Posted on • Edited on

2

Guia básico da revisão de código

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

  1. Escreva boas mensagens de commit (seguir o Conventional Commits é um bom início);
  2. Revise seu pull request antes de abrí-lo, tenha certeza que você não esqueceu algum debugger ou erro de digitação;
  3. Deixe seu pull request pequeno, isso o mantém fácil de revisar e menos nocivo ao negócio;
  4. Garanta que seu pull request passe nos testes, linters e builds, e não tenha conflitos;
  5. Escreva uma boa descrição;
  6. Comente no seu próprio pull request caso algum trecho de código não seja óbvio;
  7. Espere o revisor terminar para começar a corrigir;
  8. Escolha os revisores corretos (exemplo: alguém que já tenha trabalhado na mesma parte do código);

Para quem revisa

  1. Seja gentil;
  2. Seja uma pessoa minuciosa (este documento pode te ajudar);
  3. Busque contexto. Leia a descrição do pull request, o ticket, verifique até mesmo as telas (se houver);
  4. Tenha certeza que você separou tempo necessário para entender e fazer a melhor revisão de código que você puder;
  5. 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;
  6. 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 😉

Heroku

Build apps, not infrastructure.

Dealing with servers, hardware, and infrastructure can take up your valuable time. Discover the benefits of Heroku, the PaaS of choice for developers since 2007.

Visit Site

Top comments (0)

Postmark Image

Speedy emails, satisfied customers

Are delayed transactional emails costing you user satisfaction? Postmark delivers your emails almost instantly, keeping your customers happy and connected.

Sign up