Contribuições são sempre bem vindas. Você pode contribuir de diferentes formas como descrito a seguir. No entanto, para manter a qualidade do projeto existem algumas diretrizes que precisamos que os colaboradores sigam. Desta forma, podemos manter o controle das coisas. Estas diretrizes são principalmente relevantes quando você está planejando contribuir com o código fonte do projeto, de forma que a qualidade do código é preservada e o aprodecimento de código é evitado.
- Clicando no botão "Star" no topo da página do projeto no GitHub, nos dando mais visibilidade.
- Promovendo o projeto nas suas redes sociais.
- Relatando problemas ou solicitando recursos, por meio de uma nova issue (veja instruções abaixo)
- Melhorando a documentação do projeto.
- Corrigindo bugs e implementando novos recursos.
As seções abaixo apresentam mais informações de como contribuir em algumas destas formas.
Se você quer solicitar um recurso ou relatar um problema, verifique primeiro se o problema/recurso que você quer reportar/requisitar não foi reportado/requisitado ainda na página de issues. Tente pesquisar as issues existentes usando alguma palavra-chave antes de criar nova issue. Se não existe uma issue relacionada ainda, sinta-se livre para criar uma. Por fim, tenha certeza de que cada issue criada esteja relacionada a um único recurso solicitado ou bug.
Antes de começar a programar, você precisa primeiro fazer um fork do repositório do projeto no GitHub. Você pode corrigir um bug ou implementar um recurso de uma issue já aberta por outra pessoa ou por você mesmo, seguindo mandatoriamente os passos abaixo:
- Crie um novo branch a partir do branch
masterpara incluir suas alterações. O nome de tal branch deve ter o formatoissue-XYZ - Para criar um novo branch a partir de
master, execute:git checkout master -b issue-XYZ. Por favor, evite fazer alterações diretamente no branchmaster.
O último passo antes de você iniciar a programar é ter em mente as seguintes diretrizes, de forma que a probabilidade de suas contribuições serem incluídas no projeto serão maiores:
- Evite duplicação de código.
- Declare tudo como constante, até descobrir que precisa de fato de uma variável. Neste caso, use
let, nuncavar. - Crie funções pequenas e com uma única responsabilidade.
- Considere incluir documentação nas funções.
- Nós nos importamos com organização e indentação do código.
Crie commits pequenos, específicos. Assim como suas funções devem ser pequenas, seus commits devem ser focados em resolver um único problema. A resolução de uma issue normalmente pode requerer vários commits. Gaste algum tempo escrevendo mensagens de commit estruturadas, informativas e que descrevem claramente o que você fez em cada commit.
- Atualize o branch
masterdo seu fork para obter a última versão do projeto:
#Adicionar o endereço do repositório original (se ainda não fez)
git remote add upstream https://github.com/ifto-palmas/aglomerou.git
#Obter os branches remotos
git fetch upstream
#Entrar no seu branch master local
git checkout master
#Atualizar o seu branch master com tal branch no repositório original
git merge upstream/master- Execute um
rebasepara incluir suas alterações no topo do branchmaster, de forma que suas alterações serão baseadas na versão mais recente do código, antes de enviar sua contribuição. Para isto execute:
#Entrar no branch referente a issue em que estava trabalhando
git checkout issue-XYZ
#Incluir as suas alterações no topo da última versão no branch master
git rebase master- Faça um último commit se necessário, incluindo na primeira linha a mensagem
Close #XYZpara indicar o número da issue que está finalizando. - Execute
git pushpara enviar seu branch para o GitHub. - A partir do seu fork no GitHub, abra uma Pull Request.
- Aguarde suas contribuições serem avaliadas e obrigado antecipadamente pela contribuição 👏.