📚 Introdução ao Pull Request
O Pull Request é um recurso fundamental no desenvolvimento de software em equipe, permitindo que os contribuidores submetam suas alterações para revisão e aprovação antes de integrá-las ao código principal. Isso ajuda a garantir a qualidade do código e a prevenir conflitos entre os desenvolvedores.
Ao aprender a criar e gerenciar Pull Requests, você pode melhorar suas habilidades práticas e se tornar um desenvolvedor mais eficaz em equipe. Além disso, o conhecimento de Pull Requests é altamente valorizado por empregadores, pois demonstra sua capacidade de trabalhar em projetos colaborativos e seguir boas práticas de desenvolvimento de software.
Neste artigo, vamos explorar a importância do Pull Request e como você pode aprender a criar e gerenciar eles de forma eficaz.
Por que os Pull Requests são importantes?
Os Pull Requests são importantes por várias razões:
* Eles permitem que os contribuidores submetam suas alterações para revisão e aprovação antes de integrá-las ao código principal, o que ajuda a garantir a qualidade do código.
* Eles permitem que os desenvolvedores revisem e comentem as alterações antes de integrá-las ao código principal, o que ajuda a prevenir conflitos entre os desenvolvedores.
* Eles permitem que os contribuidores aprendam com os outros e melhorem suas habilidades práticas.
Como criar e gerenciar Pull Requests
Criar e gerenciar Pull Requests pode parecer intimidante, mas é um processo relativamente simples. Aqui estão os passos básicos:
1. Forkar o repositório: Faça uma cópia do repositório original em seu próprio repositório.
2. Clonar o repositório: Clone o repositório em seu computador.
3. Criar uma branch: Crie uma nova branch para suas alterações.
4. Fazer alterações: Faça as alterações necessárias no código.
5. Comitar: Comite as alterações.
6. Pushar: Push as alterações para o repositório.
7. Abrir um Pull Request: Abra um Pull Request para revisão e aprovação.
Lembre-se de que esses passos podem variar dependendo do repositório e do sistema de controle de versão que você está usando.
Conclusão
O Pull Request é um recurso fundamental no desenvolvimento de software em equipe, permitindo que os contribuidores submetam suas alterações para revisão e aprovação antes de integrá-las ao código principal. Ao aprender a criar e gerenciar Pull Requests, você pode melhorar suas habilidades práticas e se tornar um desenvolvedor mais eficaz em equipe. Lembre-se de que a prática leva à perfeição, então não hesite em experimentar e aprender com os outros.
🤝 Por que os Pull Requests Importam
Colaboração Segura em Equipes
Os Pull Requests são uma ferramenta fundamental para colaboração segura em equipes. Eles permitem que os desenvolvedores mantenham suas mudanças isoladas, evitando quebrar o branch principal e garantindo que as alterações sejam revisadas antes de serem implantadas.
Manter Mudanças Isoladas
Ao criar um Pull Request, os desenvolvedores criam uma branch separada para suas alterações. Isso permite que as mudanças sejam testadas e revisadas sem afetar o código principal. Ao final, as alterações podem ser implantadas no branch principal, garantindo que as mudanças sejam seguras e testadas.
Explorar Alterações
Os Pull Requests também permitem que os desenvolvedores expliquem as alterações feitas. Ao criar um Pull Request, os desenvolvedores devem fornecer uma descrição clara das alterações feitas, incluindo as razões pelas quais as alterações foram feitas. Isso ajuda a garantir que as alterações sejam compreendidas e aceitas pela equipe.
Submeter Trabalho para Revisão
Os Pull Requests permitem que os desenvolvedores submetam seu trabalho para revisão antes de ser implantado. Isso ajuda a garantir que as alterações sejam testadas e revisadas antes de serem implantadas, reduzindo o risco de bugs e erros.
Evitar Quebrar o Branch Principal
Os Pull Requests também ajudam a evitar quebrar o branch principal. Ao criar um Pull Request, os desenvolvedores criam uma branch separada para suas alterações, evitando que as mudanças afetem o código principal. Isso garante que as alterações sejam seguras e testadas antes de serem implantadas.
// Exemplo de como criar um Pull Request
git checkout -b nova-branch
// Faça as alterações necessárias
git add .
git commit -m "Descreva as alterações feitas"
git push origin nova-branch
// Abra o Pull Request no GitHub
Conclusão
Os Pull Requests são uma ferramenta fundamental para colaboração segura em equipes. Eles permitem que os desenvolvedores mantenham suas mudanças isoladas, expliquem as alterações feitas, submetam seu trabalho para revisão e evitem quebrar o branch principal. Ao entender como os Pull Requests funcionam, os desenvolvedores podem criar um ambiente de trabalho mais seguro e eficiente.
📁 Company Repo vs Open Source Repo
A diferença entre um repositório de empresa e um repositório de código aberto
Um repositório de empresa é um repositório que pertence a uma empresa ou organização, onde os membros da equipe têm acesso de escrita e podem fazer alterações diretamente no repositório. Já um repositório de código aberto é um repositório que é compartilhado com a comunidade e onde qualquer pessoa pode contribuir, mas geralmente não tem acesso de escrita direta.
Fluxo de trabalho de um repositório de empresa
No fluxo de trabalho de um repositório de empresa, os membros da equipe podem:
git clone https://github.com/empresa/repositorio.git
Depois de clonar o repositório, eles podem criar uma branch para fazer alterações:
git checkout -b nova-branch
E fazer alterações diretamente na branch:
git add .
git commit -m "Mensagem de commit"
E, por fim, fazer push para o repositório:
git push origin nova-branch
Fluxo de trabalho de um repositório de código aberto
No fluxo de trabalho de um repositório de código aberto, é necessário criar um fork do repositório para contribuir. Isso significa que você precisa criar uma cópia do repositório sob seu próprio nome de usuário no GitHub.
git clone https://github.com/usuario/repositorio-fork.git
Depois de clonar o fork, você pode criar uma branch para fazer alterações:
git checkout -b nova-branch
E fazer alterações diretamente na branch:
git add .
git commit -m "Mensagem de commit"
E, por fim, fazer push para o seu fork:
git push origin nova-branch
Após fazer push para o seu fork, você pode abrir um pull request para contribuir com as alterações para o repositório original.
Por que é necessário criar um fork para contribuir com um repositório de código aberto?
A razão pela qual é necessário criar um fork para contribuir com um repositório de código aberto é que a maioria dos repositórios de código aberto não permitem que você faça push diretamente para o repositório original. Isso é feito para garantir que as alterações sejam revisadas e aprovadas antes de serem incorporadas ao repositório original. Ao criar um fork, você pode fazer alterações e fazer push para o seu próprio repositório, e, em seguida, abrir um pull request para contribuir com as alterações para o repositório original.
📊 O Modelo de Três Camadas
Entendendo o Modelo de Três Camadas
O modelo de três camadas é uma ferramenta útil para entender o fluxo de trabalho no GitHub. Ele ajuda a clarificar como as diferentes partes do processo interagem entre si. Vamos explorar cada uma das três camadas e como elas se relacionam.
Repositório Upstream (Original)
O repositório upstream é o original, ou seja, o projeto que você está tentando contribuir. Ele é de propriedade do mantenedor ou da organização que o criou. O repositório upstream é o ponto de partida para a sua contribuição.
Seu Fork (Cópia Pessoal)
Seu fork é uma cópia pessoal do repositório upstream. Ele é criado quando você “forca” o repositório original em seu GitHub. O seu fork é onde você fará as alterações e contribuições que deseja fazer. Ele é a sua área de trabalho pessoal para o projeto.
Repositório Local (Na Sua Máquina)
O repositório local é a cópia do seu fork na sua máquina. Ele é onde você edita os arquivos e faz as alterações que deseja. O repositório local é uma cópia do seu fork, mas é uma cópia atualizada e personalizada.
Como o Modelo de Três Camadas Simplifica o Entendimento do Fluxo de Trabalho
Ao entender o modelo de três camadas, você pode visualizar como as diferentes partes do processo interagem entre si. Você pode ver como o repositório upstream é o ponto de partida, e como o seu fork é a sua área de trabalho pessoal. Você também pode ver como o repositório local é uma cópia atualizada e personalizada do seu fork.
Isso ajuda a simplificar o entendimento do fluxo de trabalho e a tornar mais fácil de contribuir para projetos no GitHub.
git clone https://github.com/your-username/repo-name.git
cd repo-name
git checkout -b new-blog-post-on-pull-requests
git add .
git commit -m "Start blog post on pull requests"
git push origin new-blog-post-on-pull-requests
📝 Passo a Passo para Criar um Pull Request
🔧 Passo 1: Instale o Git e Certifique-se de que Funciona
Para criar um Pull Request, você precisará ter o Git instalado em seu computador. Além disso, você precisará ter uma conta no GitHub e um terminal (Windows Terminal ou macOS Terminal) e um editor de código, como o VS Code.
git --version
🔗 Passo 2: Fork o Repositório
Agora é hora de criar uma cópia do repositório original em seu próprio GitHub. Isso é chamado de “fork”. Para fazer isso, vá para o repositório original no GitHub e clique em “Fork”.
git clone https://github.com/your-username/repo-name.git
📁 Passo 3: Clone o Seu Fork, Não o Repositório Original
Aqui está o passo mais comum de erro para iniciantes. Você precisa clonar o seu fork, não o repositório original.
git clone https://github.com/your-username/repo-name.git
🌿 Passo 4: Crie uma Branch antes de Fazer Mudanças
Antes de fazer qualquer mudança, crie uma branch para trabalhar. Isso é chamado de “feature branch”. Para criar uma branch, use o comando:
git checkout -b new-blog-post-on-pull-requests
💻 Passo 5: Faça Mudanças Locais
Agora é hora de fazer as mudanças que você deseja. Edite os arquivos que você deseja alterar. Lembre-se de que tudo que você está fazendo agora é local ao seu computador.
📁 Passo 6: Stage das Mudanças
Depois de fazer as mudanças, você precisa stage-as para que elas sejam incluídas no commit. Para stage-as, use o comando:
git add .
📝 Passo 7: Commit com Mensagem Clara
Agora é hora de commitar as mudanças. Use o comando:
git commit -m "Start blog post on pull requests"
🔍 Passo 8: Verifique o Remote antes de Push
Antes de pushar as mudanças, verifique se o remote está configurado corretamente. Use o comando:
git remote -v
➡️ Passo 9: Push a Branch para o GitHub
Agora é hora de pushar as mudanças para o GitHub. Use o comando:
git push origin new-blog-post-on-pull-requests
📝 Passo 10: Abra o Pull Request
Agora é hora de abrir o Pull Request. Vá para o seu fork no GitHub e clique em “Compare & pull request”. Escreva um título e uma descrição úteis para o Pull Request.
📊 O que Acontece Depois de Abrir um Pull Request
Revisão pelo Mantenedor
Após abrir um Pull Request, o mantenedor do projeto revisará as alterações. Isso pode incluir a verificação da qualidade do código, a análise de bugs e a avaliação da funcionalidade adicional. O mantenedor pode também solicitar mudanças ou pedir mais informações para garantir que as alterações sejam apropriadas para o projeto.
Testes
O mantenedor pode realizar testes para garantir que as alterações não afetem a estabilidade do projeto. Isso pode incluir testes unitários, integração e de aceitação. Se os testes falharem, o mantenedor pode solicitar mudanças para corrigir os problemas.
Comentários e Solicitações de Mudanças
O mantenedor pode adicionar comentários ao Pull Request para fornecer feedback ou solicitar mudanças. Isso pode incluir sugestões de melhoria, correções de erros ou pedidos de mais informações. O contribuidor deve responder aos comentários e implementar as mudanças solicitadas.
Importância da Colaboração e Comunicação Clara
A colaboração e a comunicação clara são fundamentais para o sucesso de um Pull Request. O contribuidor deve estar disposto a trabalhar com o mantenedor e outros membros da equipe para garantir que as alterações sejam apropriadas e de alta qualidade. Isso inclui a comunicação clara sobre as alterações, a resposta a comentários e a implementação de mudanças solicitadas.
# Exemplo de como o mantenedor pode revisar e comentar um Pull Request
git clone https://github.com/usuario/repo.git
cd repo
git checkout -b new-feature
git add .
git commit -m "Adicionando nova feature"
git push origin new-feature
Exemplo de como o contribuidor pode responder a comentários e implementar mudanças solicitadas
# Exemplo de como o contribuidor pode responder a comentários e implementar mudanças solicitadas
git checkout -b fix-feature
git add .
git commit -m "Corrigindo feature"
git push origin fix-feature
📚 Conclusão
Aprenda a começar pequeno, praticar o fluxo de trabalho do Pull Request e entender como isso pode ajudar na preparação para estágios, entrevistas e trabalho em equipe.
Pratique o Fluxo de Trabalho
Não é necessário fazer uma grande contribuição para o open source no primeiro dia. Comece com pequenas melhorias, como corrigir erros de documentação ou criar um post de blog. Com o tempo, você se sentirá mais confortável com o fluxo de trabalho e poderá fazer contribuições mais significativas.
Entenda a Importância do Fluxo de Trabalho
O fluxo de trabalho do Pull Request é essencial para o desenvolvimento de software em equipe. Ele ajuda a garantir que as mudanças sejam testadas e revisadas antes de serem incorporadas ao código principal. Além disso, ele ajuda a evitar conflitos e a garantir que as mudanças sejam feitas de forma segura e eficiente.
Prepare-se para Estágios, Entrevistas e Trabalho em Equipe
O fluxo de trabalho do Pull Request é uma habilidade valiosa que pode ajudar a destacar você em estágios, entrevistas e trabalho em equipe. Ao praticar o fluxo de trabalho e entender sua importância, você estará melhor preparado para lidar com os desafios do desenvolvimento de software em equipe.
git config --global user.email "you@example.com"
git config --global user.name "Your Name"
Fonte de Referência: dev.to.
Curadoria e Adaptação: Redação Yassutaro Developers.