GitubSession

Contribuindo para projetos de código aberto usando o git

Bem -vindo ao nosso projeto! Estamos empolgados por você estar pensando em contribuir para o desenvolvimento de código aberto. Este guia o levará através dos comandos GIT essenciais e práticas recomendadas para tornar sua contribuição fácil e bem -sucedida.

Índice

1. Batendo o repositório
2. Clonando o repositório
3. Criando um ramo
4. Fazendo alterações
5. Cometendo mudanças
6. Empurrando mudanças
7. Criando um pedido de tração
8. Sincronizando seu garfo
9. Dicas para escrever boas mensagens de compromisso

---

1. Fifurando o repositório

Antes de começar a contribuir, você precisa gastar o repositório. A forking cria uma cópia do repositório sob sua própria conta do GitHub.

Passos:

1. Navegue até a página do repositório.
2. Clique no botão "garfo" no canto superior direito.
3. Agora você terá uma cópia do repositório em sua conta do GitHub.

---

2. Clonando o repositório

Depois de marcar o repositório, você precisa cloná -lo para sua máquina local para poder trabalhar nela.

git clone https://github.com/your-username/repository-name.git

---

3. Criando um ramo

Depois de clonar o repositório, crie uma nova filial para trabalhar em suas alterações. Sempre trabalhe em um ramo separado para evitar conflitos com o ramo principal:

git checkout -b feature/your-branch-name

---

4. Fazendo alterações

Agora que você está em sua filial, faça as alterações necessárias no código, documentação ou outras partes do projeto. Certifique -se de testar tudo antes de passar para a próxima etapa.

---

5. Comprometer mudanças

Quando suas mudanças estão completas, é hora de cometê -las. Siga estas etapas:

1. Adicione as alterações à área de estadiamento:

git add .

2. Compreenda as mudanças com uma mensagem clara e descritiva:

git commit -m " Your descriptive message here "

3. Verifique se sua mensagem de confirmação explica claramente as alterações que você fez.

6. Apertando mudanças

Depois de comprometer suas alterações localmente, empurre a filial para o repositório do GitHub.

git push origin feature/your-branch-name

Isso enviará sua filial para o seu repositório bifurcado no Github.

7. Criando um pedido de tração

Com suas alterações empurradas para o Github, você está pronto para enviar uma solicitação de tração (PR) para que os mantenedores possam revisar seu trabalho.

• Navegue até o seu repositório bifurcado no Github.
  
• Clique no botão "Compare & Pull Request".
  
• Forneça um título e uma descrição detalhada de suas alterações.
  
• Envie a solicitação de tração.
  
• Após a revisão, os mantenedores mesclarão seu PR ou fornecerão feedback para revisões.
  

8. Sincronizar seu garfo

Se o repositório original for atualizado enquanto estiver trabalhando, convém sincronizar o garfo para mantê-lo atualizado. Aqui está como:

1. Adicione o repositório upstream como um controle remoto:

git remote add upstream https://github.com/original-owner/repository-name.git

2. Pegue as mudanças mais recentes do repositório a montante:

git fetch upstream

3. Mesclar as mudanças a montante para o seu ramo principal local:

git checkout main
git merge upstream/main

4. Empurre a filial principal atualizada para o seu garfo:

git push origin main

9. Dicas para escrever boas mensagens de confirmação

• Mantenha -o conciso: mire em uma mensagem de confirmação com menos de 50 caracteres.
  
• Use o humor imperativo: por exemplo, escreva "Corrija o bug" em vez de "corrigir bug".
  
• Forneça contexto: inclua o número da questão ou descreva o objetivo da mudança.
  Exemplo: Corrija #42 - Resolva Bug na autenticação do usuário.