Skip to content

Instantly share code, notes, and snippets.

@rogeriopradoj
Last active December 21, 2020 11:11
Show Gist options
  • Star 5 You must be signed in to star a gist
  • Fork 1 You must be signed in to fork a gist
  • Save rogeriopradoj/9c2208b50bcb1f047d19 to your computer and use it in GitHub Desktop.
Save rogeriopradoj/9c2208b50bcb1f047d19 to your computer and use it in GitHub Desktop.
Dicas de como contribuir com open source by @rogeriopradoj

Olá, vamos para algumas dicas de como contribuir com opensource!

Procure seguir o fluxo base que o GitHub ensina para nós

O pessoal do GitHub tem um guia que ensina o GitHub flow, https://guides.github.com/introduction/flow/. A base que ele nos ensina é:

  • crie um branch para a alteração que você vai fazer
  • faça os commits (ou o commit único) das suas alterações
  • abra o pull request
  • espere a aprovação do responsável pelo projeto
  • be happy!

Realmente vale a pena ler o guia. É um texto de cinco minutos, interativo, acesse: https://guides.github.com/introduction/flow/

Tenha pelo menos dois repositórios remotos: origin e upstream

Documentação


O origin é o endereço do seu fork lá no GitHub.

O upstream é o endereço do repositório original para o qual você vai contribuir.

Para ver na sua linha de comando o que está configurado:

git remote -v

Se você vir na saída desse comando tanto o origin quanto o upstream, beleza! Caso contrário (se só aparecer o origin), vamos ver como fazer para ter também o upstream.

Tomemos como exemplo:

Seu fork, lá no GitHub ficaria: zezinho/ManoWars (https://github.com/zezinho/ManoWars.git)

Em geral, o que fazemos depois é um apenas um git clone. O que falta aí é mais um comando: git remote add. Esse comando serve para adicionar repositórios remotos ao seu repositório local.

Quando você faz um git clone, automaticamente é adicionado o repositório remoto origin. Com o git remote add você pode adicionar quantos outros você precisar.

Se você estiver clonando pela primeira vez (digamos que você acabou de forkar o projeto oficial lá no GitHub):

git clone https://github.com/zezinho/ManoWars.git
git remote add upstream https://github.com/rogeriopradoj/ManoWars.git

Caso você já tiver clonado o projeto na sua máquina:

git remote add upstream https://github.com/rogeriopradoj/ManoWars.git

É isso aí, rode agora o comando

git remote -v

e veja se você já tem o origin (seu fork no GitHub) e o upstream (repositório oficial no GitHub).

Procure não alterar o branch master

A ideia principal é que o branch master ande junto com o branch master do projeto principal.

E como você faz as suas alterações? É fácil: crie sempre um branch para fazer as suas alterações!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment