Como contribuir para o Openredu

Saudações comunidade! :slight_smile:

Com o auxílio de @hscs, montamos esse guia de contribuição para orientá-los nos procedimentos necessários para reportar e corrigir um bug encontrado, bem como adicionar novas funcionalidades ao Openredu. Confira! :smile:

Você encontrou um bug?

  • Primeiro veja se o bug em questão já não foi reportado, pesquisando no GitHub nas Issues do projeto.

  • Se você não encontrou uma issue relacionada ao problema em questão, abra uma nova. Tenha certeza de incluir um titulo e uma descrição clara, e também o máximo de informações relevantes que puder. Melhor ainda se puder anexar uma imagem ou os passos necessários para reproduzir o erro, demonstrando que o comportamento esperado não estava ocorrendo.

  • Se possível, use o template abaixo para criar a isse. Simplesmente copie e preencha os dados no campo de descrição da issue:

Título:
Descrição:
Etapas:
Resultado:
Resultado esperado:
Versão:
Navegador:
Sistema Operacional:
Anexos:

  • Para informações mais detalhadas e boas práticas ao submeter uma issue, uma leitura recomendada é o guia de open source.

Você desenvolveu uma correção para um bug?

  • Abra um novo pull request no GitHub com a correção desenvolvida. Tenha certeza de realizar o pull request no branch teste-contribuicoes, para que a equipe possa testar sua implementação antes de efetivamente colocarmos essa versão no ramo master.

  • Garanta que a descrição do pull request descreve claramente o problema e como foi implementada a solução. Inclua também o número da issue, se houver.

Você pretende adicionar uma nova feature ou mudar uma feature existente?

  • Não abra uma issue nem crie um pull request. Sugira sua mudança no fórum da comunidade e se quiser, já coloque a mão na massa em seu fork.

  • Não abra uma issue/pull request até que você tenha coletado feedback positivo suficiente sobre essa mudaça. Usar a aba de issues é prioritára para bug reports.

  • Assim que sua modificação for aprovada pela comunidade geral, abra uma issue seguindo o máximo possível o modelo já apresentado e coloque como anexo o tópico do fórum que discutiu e aprovou a feature em questão.

  • Crie seu pull request referenciando a issue no branch teste-contribuicoes para avaliação da equipe. Se estiver tudo certo, sua feature será incorporada a master e se tornará oficial nas próximas versões do Openredu!

Vocẽ tem dúvidas sobre o código fonte?

  • Pergunte qualquer coisa relacionada ao código do Openredu no fórum.

Você quer contribuir com a documentação?

  • Se você deseja melhorar os guias do Openredu para deixá-los mais coerentes, consistentes, legíveis, ou adicionar informação que falta, corrigir erros factuais, erros de digitação ou deixá-los atualizados com a última versão do Openredu, clone o repositório da wiki, faça sua contribuição, e nos envie seu pull request!

Esse mesmo guia também se encontra no nosso repositório do GitHub, podendo ser acessado clicando aqui.

Atenciosamente,
Ricardo Fagundes.

Baseado no guia de contribuição da comunidade Ruby on Rails.

1 Curtida