Criação da PR (Pull Request)

O primeiro passo para um bom Code Review.

A importância de uma PR bem feita

"Tudo termina bem, quando começa bem". Essa ditado popular, aqui, faz muito sentido!

Um bom Code Review começa com uma boa PR, pois é ali que o engenheiro criador da PR deixa as instruções necessárias para quem for revisar seu código.

Uma PR de "qualidade" deve possuir todas as informações pertinentes para que seu conteúdo seja entendido e analisado pelos revisores.

Aqui, veremos as principais informações que uma PR deve conter:

• Título coeso: o título da PR deve condizer com a feature/fix que ela carrega. Por exemplo:

  • Novo cadastro de produtos;

  • Fix: Correção da listagem de contas a receber;

• Número/ID do card: O corpo da PR deve trazer consigo o número/ID do card ao qual ela representa, pois é ali que todas as regras de negócio do conteúdo se encontra;

• Resumo do conteúdo: Um breve, mas informativo resumo do que a PR representa. Exemplo:

  • Importação de produtos via arquivo csv.

• O que foi feito: Descrever, resumidamente, o que foi realizado na PR. Exemplo:

  • Criado botão de importação de produtos via csv.

• Roteiro de testes: Aqui, o autor da PR deve descrever como os revisores poderão testar o conteúdo da mesma. Quanto mais detalhes, melhor será o teste. Exemplo:

  • Entrar na branch feature/aaaa e rodar as migrations. No cadastro de produtos, clicar no novo botão "importar produtos", preencher o campo com o arquivo csv, e clicar em importar. A importação deve ocorrer sem nenhum problema, e a listagem de produtos deve ser atualizada automaticamente.

• Prints: Material visual sempre ajuda a quem vai testar algo. Portanto, sempre que possível, a adição de prints é bem vinda para auxiliar nos testes.

Após a criação da PR, a mesma deve ser notificada ao time.