Pular para conteúdo

Como criar uma solicitação de pull bem-sucedida no Github

Contribuir para projetos é uma ótima maneira de aprender mais sobre codificação social, tecnologias e seus ecossistemas, bem como criar relatórios de bugs efetivos, solicitações de recursos e, o mais importante, fazer uma contribuição positiva ao projeto.

Antes de iniciar, verifique se o projeto tem instruções de contribuição e siga-as. Aqui está um passo a passo para criar uma solicitação de pull bem-sucedida no Github:

  • Crie um fork pessoal do projeto no Github
  • Clone o fork em sua máquina local, chamando o repositório remoto no Github de “origem”.
  • Adicione o repositório original como um remoto chamado “upstream”.
  • Atualize o repositório local com as alterações upstream.
  • Crie um novo branch para trabalhar.
  • Implemente ou corrija o recurso, comentando o código.
  • Siga o estilo de código do projeto, incluindo o recuo.
  • Execute os testes, se houver.
  • Escreva ou adapte os testes, se necessário.
  • Adicione ou altere a documentação, se necessário.
  • Junte seus commits em um único commit com rebase interativo do Git.
  • Envie o branch para o seu fork no Github.
  • Abra uma solicitação de pull no branch correto.
  • Após a aprovação e mesclagem da solicitação de pull, atualize o repositório local com as alterações- upstream e exclua suas ramificações extras.

Observe que as mensagens de commit devem ser escritas no tempo presente e descrever o que o commit, quando aplicado, faz com o código. Seguir esses passos garantirá que sua contribuição seja bem-vinda.