Como criar um fluxo de trabalho de revisão com Pull Requests no GitHub

O fluxo de trabalho de revisão com Pull Requests (PRs) no GitHub é uma prática essencial para garantir a qualidade do código em projetos colaborativos. Neste manual, abordaremos como configurar e utilizar esse fluxo de forma eficaz.

Introdução

Pull Requests permitem que os desenvolvedores proponham alterações no código, que podem ser revisadas e discutidas antes de serem integradas ao projeto principal. A seguir, vamos detalhar o processo de criação e revisão de um PR no GitHub.

Passo a Passo para Criar um Pull Request

1. Crie um repositório no GitHub

• Acesse sua conta no GitHub.
• Clique em New para criar um novo repositório.
• Preencha as informações necessárias e clique em Create repository.

2. Clone o repositório localmente

git clone https://github.com/usuario/nome-do-repositorio.git

3. Crie uma nova branch

Antes de fazer alterações, crie uma nova branch para suas modificações.

git checkout -b nome-da-sua-branch

4. Faça suas alterações

Edite os arquivos conforme necessário. Após concluir, adicione e faça commit das suas mudanças:

git add .

git commit -m "Descrição das alterações"

5. Envie suas alterações para o GitHub

git push origin nome-da-sua-branch

6. Crie o Pull Request

Vá até o repositório no GitHub e clique em Compare & pull request. Adicione uma descrição e clique em Create pull request.

7. Revisão do Pull Request

Os colaboradores podem agora revisar o PR, comentar e solicitar mudanças se necessário. Após a revisão, o PR pode ser mesclado.

8. Mesclando o Pull Request

Uma vez aprovado, clique em Merge pull request e depois em Confirm merge.

Conclusão

O uso de Pull Requests é uma prática recomendada para manter a qualidade do código. Sempre incentive a revisão por pares e utilize comentários construtivos.

Dica: Utilize templates de Pull Request para padronizar as informações que os colaboradores devem fornecer ao criar um PR.