CONTRIBUTING.md

Guia Para Contribuidores

Index

• Como contribuir?
  • 1º Passo - Fork
  • 2º Passo - Clonagem
  • 3º Passo - Add linke para repositório oficial
  • 4º Passo - Crie uma branch para contribuir
  • 5º Passo - Adicione e commite a contribuição
  • 6º Passo - Envie a branch com a contribuição para o fork
  • 7º Passo - Faça o pull requets da branch para o projeto oficial
• Contribuição aprovada, o quê fazer?
  • Deletando branch antiga localmente
• Sincronizando o fork/clone com o repositório oficial
  • Sincronize o clone
  • Sincronize o fork
• Links úteis

Como contribuir?

Para fazer contribuições certifique-se de que tenha o git instalado em seu ambiente.

Com o git já instalado, siga os passoa abaixo.

1º Passo

Faça o fork desse repositório para sua conta clicando no botão:

Você será redirecionado para sua conta assim que o processo for concluído.

2º Passo

Após ter o repositório em sua conta, faça o clone em seu ambiente local:

$ git clone https://github.com/<NOME_DA_SUA_CONTA>/exercicios-CeV.git

3º Passo

Com o clone em seu ambiente, linke o repositório local ao remoto da organização Coding in Community:

$ git remote add upstream https://github.com/Coding-in-community/exercicios-CeV.git

Isso servirá para sincronizar atualizações feitas no repositório oficial para seu ambiente local.

OBS: Esse comando só é necessário executar uma unica vez após a clonagem.

Para verificar se ocorreu tudo certo, execute em no terminal:

$ git remote --v

Se tudo ocorreu bem, deverá ter uma saída semelhante a essa:

origin  https://github.com/<NOME_DA_SUA_CONTA>/exercicios-CeV.git (fetch)
origin  https://github.com/<NOME_DA_SUA_CONTA>/exercicios-CeV.git (push)
upstream        https://github.com/Coding-in-community/exercicios-CeV.git (fetch)
upstream        https://github.com/Coding-in-community/exercicios-CeV.git (push)

4º Passo

Crie uma branch para fazer sua contribuição:

$ git checkout -b feature/nome_da_feature

Agora adicione suas contribuições para o projeto.

5º Passo

Adicione suas contribuições:

$ git add arquivo_exemplo.py

OBS: Adicione todos os arquivos/diretórios adicionados e/ou modificados

Agora faça o commit:

$ git commit -m "Descrição da contribuição"

6º Passo

Concluindo sua contribuição envie-a para o repositório remoto em sua conta:

$ git push origin feature/nome_da_feature

7º Passo

Em sua conta no github envie um Pull Request com sua contribuição para o repositório oficial:

Agora aguarde a revisão de um dos mantenedores do projeto.

Contribuição aprovada, o quê fazer?

Depois de um pull request aprovado, caso não queira contribuir novamente, poderá apagar a branch que usou para fazer a contribuição na própria página do Pull Request ou excluir o fork de sua conta.

Caso queira fazer outras contribuições que não tenha relação com a branch da contribuição antiga, delete a antiga e crie uma nova.

Deletando branch antiga localmente

Vá para a branch padrão:

$ git checkout master

Delete a antiga:

$ git branch -d nome_da_branch_antiga

Agora crie uma nova branch e repita os passos 4º Passo, 5º Passo, 6º Passo e 7º Passo

Sincronizando o fork/clone com o repositório oficial

Para sincronizar o fork/clone com as novas features que tem no repositório oficial siga os passos abaixo:

Sincronize o clone

Certifique-se de estar na branch padrão, que para esse projeto é a master:

$ git checkout master

Agora sincronize com:

$ git pull upstream master

Após isso o ambiente local estará sincronizado.

Sincronize o fork

Com o ambiente local sincronizado, sincronize o remoto também:

$ git push origin master

Pronto, ambiente local e remoto sincronizado com o oficial.

Links úteis

Caso tenha dúvida com algum comando usado ou queira entender melhor, veja um dos links abaixo:

• Documentação do git
• Curso de Git - Rodrigo Branas