Antes de qualquer coisa, verifique se sua proposta de alteração não foi discutida em outro lugar. Leia o README do repositório, consulte as issues (tanto as abertas quanto as fechadas) e as Pull Requests já existentes. Não precisa ficar horas e horas analisando tudo, mas uma rápida pesquisa por palavras-chave já é suficiente para evitar retrabalho.
Se não encontrar sua ideia em nenhum lugar do repositório, você está pronto para iniciar sua contribuição. Mas não esqueça de ler atentamente este Guia, para verificar quais as orientações específicas.
Você deve abrir uma issue nas seguintes situações:
- Relatar um erro que você não conseguiu resolver por conta própria
- Discutir um tópico relacionado ao projeto ou uma ideia
- Propor uma nova funcionalidade
Normalmente, as Pull Requests vão ser utilizadas nos seguintes casos:
- Submeter correções de código
- Realizar uma contribuição que já foi solicitada ou que já foi discutida em uma issue
Considerando que se trata de um repositório visando o aprendizado dessa ferramenta de contribuição em projetos open source, você poderá submeter códigos simples nas linguagens HTML, CSS e JavaScript, utilizando os templates disponibilizados no diretório templates. Para cada linguagem, há um documento diferente, que atendem às particularidades de cada linguagem. Procure observar os comentários em cada arquivo, que indicam trechos de código que não devem ser alterados e orientam a respeito do conteúdo esperado. Faça uma cópia do template desejado, renomeie em conformidade com o conteúdo a ser enviado e salve na pasta resources.
Abaixo, o link para cada um dos templates:
Não esqueça de realizar cada uma das seguintes etapas:
- Faça o fork do repositório e clone o seu conteúdo localmente. Conecte seu repositório local ao repositório original como
upstream, adicionando-o como remoto. Para manter sua cópia local sincronizada, realize com frequência o comandopulldo Git. Assim, mantendo sua versão sempre atualizada, ao submeter o Pull Reques, menores serão as chances de conflitos no código durante omerge. - Crie um novo
branch. Evite alterações diretamente no main. - Ao enviar o Pull Request, faça referência a qualquer issue relevante, por exemplo, informando na mensagem "Closes #17". Com isso, ao sendo aceita a Pull Request, o GitHub irá automaticamente fechar a issue correspondente.
- Sempre que necessário, inclua imagens que possam ilustrar com maior precisão as razões e o resultado de suas alterações. No GitHub, ao fazer Pull Request, basta arrastar e soltar a imagem no corpo da mensagem.
- Teste suas alterações! Tenha certeza de que sua contribuição não impactará o projeto.
Mesmo em um projeto ativo, é possível que sua contribuição não receba uma resposta. Procuraremos analisar e responder todas as Pull Requests o quanto antes. De qualquer forma, se entender que está demorando mais do que deveria, comente no mesmo tópico, solicitando educadamente uma avaliação aos responsáveis. Não entre em contato em particular. A comunicação pública em projetos de código aberto é essencial.
Pode ocorrer de alguém solicita alterações em sua contribuição. Quando isso ocorrer, seja responsivo. Se não souber como fazer alterações, pesquise o problema ou peça ajuda se precisar.
Caso sua contribuição não tenha sido aceita, não estando claras as razões para tal, é perfeitamente razoável solicitar esclarecimentos aos responsáveis. Em última análise, respeite essa decisão, afinal, são os mantenedores do repositório. Não discuta, nem seja hostil.