Fluxo de Revisao de Codigo

Para garantir a qualidade do sistema e da qualidade do mesmo, vários pontos precisam ser checados na revisão de um pull request. Por sorte, existem vários serviços para auxiliar que são grátis para projetos open source.

• Primeiro passo: Garantir conformidade com os padrões utilizados

  • O projeto utiliza o @houndci para fazer revisão automática de estilos.
  • Esse passo consiste apenas de pedir para que o autor corrija as não conformidades.

• Segundo passo: Verificar a inserção de bugs

  • O Projeto utiliza o travis para rodar a suíte de testes automaticamente.
  • Esse passo consite apenas de verificar se os testes passaram. Isso pode ser feito através do próprio github.

• Terceiro passo: Verificar a cobertura de testes

  • O projeto utiliza o @coveralls para fazer revisão automática da cobertura de código.
  • Pull requests em que a cobertura de código diminui só devem ser aceitos em situações extremas onde o autor e o revisor devem estar de acordo com isso.

• Quarto passo: Avaliar o código e testes

  • Nesse passo o que conta bastante é o bom senso. Se o revisor não concordar com algo implementado, ele e o autor devem discutir a implementação e chegar a um consenso.

• Passo condicional: Avaliar a view

  • Avaliar o desenvolvimento das views através do teatro caso necessário.

• Quinto passo: Pedir para que o autor faça o rebase de commits

  • Esse passo consiste de pedir para o autor do pull request fazer o rebase dos commits caso ele tenha adicionado commits extras para resolver os passos anteriores.
  • O ideal é manter o minímo de commits mas pode ser necessário 3 commits. Vale o bom senso.
  • Tutorial no wiki

• Sexto passo: Checar se tudo está de acordo e aceitar o pull request Ao resolver alguns do passos, pode ser que algum dos passos anteriores que estavam ok seja invalidado, portanto cheque e somente aceite o pull request se tudo estiver ok

• Último passo: Agradecimentos

  • Agradeça ao autor do pull request. 😄