💊Pull Requests

by: João Pedro!

Fluxo de Pull Request

O fluxo de pull request é uma prática comum no desenvolvimento de software que permite aos desenvolvedores colaborar e revisar o código antes de ser incorporado à branch principal do repositório. Vamos descrever brevemente o fluxo de um pull request iniciado por um desenvolvedor:

1. O desenvolvedor inicia criando uma nova branch a partir da branch "develop" no repositório Git. Isso é feito para isolar as alterações e evitar conflitos com o trabalho em andamento de outros membros da equipe.

2. O desenvolvedor faz as alterações necessárias na sua branch local, implementando as funcionalidades ou correções desejadas.

3. Uma vez que as alterações estejam prontas, o desenvolvedor realiza o commit e o push dessas alterações para a branch remota correspondente no repositório Git.

4. Em seguida, o desenvolvedor cria um pull request (PR) no repositório, selecionando a branch que contém suas alterações como a branch de origem e a branch "develop" como a branch de destino.

5. O integrante do time responsável pela revisão de código e testagem é notificado sobre o pull request e realiza a revisão das alterações. Esse membro pode analisar o código, identificar erros, sugerir melhorias e executar os testes necessários para garantir a qualidade do código.

6. Durante a revisão, o integrante do time pode fazer comentários no próprio pull request, apontando falhas nos testes ou identificando erros no código. Esses comentários servem para fornecer feedback construtivo ao desenvolvedor que criou o pull request.

7. O desenvolvedor que criou o pull request acompanha os comentários e realiza as correções necessárias de acordo com as sugestões e feedback recebidos. Esse ciclo de revisão e correção pode ocorrer até que as alterações sejam consideradas satisfatórias.

8. Após a aprovação da revisão de código e testagem, o desenvolvedor que criou o pull request é responsável por realizar o merge das alterações na branch "develop" no repositório remoto. Isso pode ser feito usando a funcionalidade de merge no sistema de controle de versão, como o Git.

9. Após o merge, as alterações estão integradas à branch "develop" e disponíveis para outros membros da equipe. A branch criada pelo desenvolvedor pode ser excluída, uma vez que o trabalho foi concluído e as alterações foram incorporadas ao projeto principal.

Esse fluxo de pull request facilita a revisão e a colaboração entre os membros da equipe, garantindo que o código seja revisado e testado antes de ser integrado à branch principal do repositório, promovendo a qualidade e a consistência do código-fonte do projeto.

Pull Request Template

Link para o Pull Request Template

O template de pull request acima é uma estrutura pré-definida para fornecer informações e orientações relevantes sobre as alterações realizadas no código e como testá-las. Ele é usado para facilitar o processo de revisão de código por outros desenvolvedores ou membros da equipe.

A seção "Changes" (Alterações) descreve brevemente o que foi feito no pull request. No exemplo fornecido, foi concluída uma tarefa específica e feita uma alteração no aplicativo.

A seção "What to test" (O que testar) lista os diferentes aspectos que devem ser testados para garantir a qualidade das alterações. No exemplo, são mencionados testes de layout em dispositivos diferentes, fluxo principal (happy path) e tratamento de erros.

Na seção "How to get there" (Como chegar lá), são fornecidas informações sobre a configuração necessária para testar as alterações. No exemplo, são dados detalhes sobre o ambiente de teste, incluindo o sabor (flavor) de staging, informações de login e senha.

A seção "Steps" (Passos) fornece uma lista de etapas que devem ser seguidas para reproduzir o cenário de teste. No exemplo, é necessário fazer login e navegar para uma página específica do aplicativo.

A seção "Observations" (Observações) é usada para fornecer informações adicionais relevantes para o pull request. No exemplo, há espaço para listar problemas conhecidos e práticas recomendadas de revisão de código, como evitar impressões ou comentários desnecessários, organizar o código adequadamente, nomear corretamente funções e variáveis e evitar código repetido.

Essa estrutura de template ajuda a padronizar as informações fornecidas nos pull requests, facilitando a revisão e o entendimento das alterações feitas por outros membros da equipe.