Skip to main content

Contribuindo com o flowbuild

Gostaríamos muito da sua contribuição para tornar o flowbuild ainda melhor!

Verifique nossa documentação.

Veja aqui algumas orientações para você:

Tem uma dúvida?#

Se você tiver dúvidas de como contribuir ou como usar o flowbuild, por favor, junte-se à nossa página do Gitter.

Encontrou um problema?#

Se você encontrou um problema no código ou falha da documentação, envie um issue no nosso repositório ou submeta uma Pull Request com a correção.

Favor checar as recomendações para submissão.

Regras para Submissão#

Submetendo uma Issue#

Antes de submeter sua issue, por favor, faça uma busca na lista de issues do Github. Talvez sua pergunta já tenha sido respondida.

Se seu problema parece ser um bug que ainda não foi reportado, abra uma nova issue. Ajude-nos a maximizar o esforço que podemos dispor consertando issues e adicionando novas features ao não reportar issues duplicadas. Ao fornecer as seguintes informações, você nos ajuda a resolver rapidamente os problemas:

Submetendo um Pull Request#

Antes de submeter seu pull request, considere as diretrizes a seguir:

  • Busque no GitHub por um Pull Request aberto ou fechado que tenha a ver com sua submissão. Você não quer trabalho duplicado.
  • Fork esse repositório.
  • Clone sua cópia.
git clone https://github.com/YOUR_USERNAME/workflow.git -o flow-build-workflow
cd flow-build-workflow/
  • Após clonar, configure um novo remote upstream (isso ajuda a manter seu fork atualizado):
git remote add upstream https://github.com/flow-build/workflow.git
  • Faça suas mudanças em uma nova git branch:
git checkout -b my-fix-branch master

Veja o padrão para nomes de branch para nos ajudar com uma melhor identificação.

  • Crie seu patch e rode os testes apropriados.
  • Siga nosso Formato de código.
  • Execute um Commit de suas mudanças usando uma mensagem de commit descritiva que usa o tempo presente e imperativo: use "alterar"; não use "alterado" nem "alterações".
git commit -a

Nota: a linha de comando commit -a é opcional e irá automaticamente usar os comandos "add" e "rm" nos arquivos editados.

  • Dê um Push na sua branch para o GitHub:
git push origin my-fix-branch

No Github, envie um pull request para workflow:master. Se sugerirmos mudanças, então:

  • Faça as devidas atualizações.
  • Rode novamente o flow-build/workflow e tenha certeza que todos os testes ainda passam.
  • Realize um commit de suas mudanças para sua branch (exemplo: my-fix-branch).
  • Realize um push das mudanças para o seu repositório no GitHub (isso vai atualizar seu Pull Request).

Se o PR ficar muito desatualizado, poderemos pedir que você execute um rebase e force um push para atualizar a PR:

git fetch upstream
git rebase upstream/master
git push origin my-fix-branch -f

E é isso! Agradecemos por sua contribuição!

Depois que seu pull request for aceito#

Depois que seu pull request for aceito, você pode tranquilamente apagar sua branch e executar um pull do repositório principal (upstream):

  • Apague a branch remota no Github através ou da interface web ou através do seu shell local com o comando:

    git push origin --delete my-fix-branch
  • Execute um checkout para a branch master:

    git checkout master -f
  • Apague sua branch local:

    git branch -D my-fix-branch
  • Atualize sua branch master com a última versão upstream:

    git pull --ff upstream master

Padrões de Formatação#

Para assegurar a consistência através do código fonte, chque nossas convenções de código.