O que é importante para Guideline (Padrão de Documentação)

Passo a passo para contribuir com a comunidade

  • Preparação do ambiente
  • As tecnologias utilizadas pelo OpenRedu

Padronização da realização de um Commit

  • Como realizar um commit de forma padrão

Fluxo de contribuição

@pjsn e @caique,

Como nossa comunicação sobre o guideline estava centralizada nos e-mails, acabei perdendo o timing da resposta.
Mas já que o documento não foi finalizado e compartilhado com a comunidade, vou repassar aqui minhas opnioes para que novos contribuidores possam continuar esse trabalho:

Creio que o guideline deve ser amigável e entusiástico!

Adotar padrões consolidados:

CommitMessages

Roadmap

Pela evolução do tópico Release (rolling || fixed) => Git workflow é bom preparar o guideline levando em conta a provável adoção dos padrões citados.

Outra pratica comum em projetos open source é disponibilizar um documento CONTRIBUTING.md contendo todas as informações úteis a um possível contribuidor. p. ex. (1), (2) e (3)

Acho importante esclarecer que existem varias maneiras de contribuir além do código:

Sendo um testador, tradutor, escrevendo documentação, apoiando a comunidade, ajudando na triagem de bugs, sugerindo funcionalidades e mudanças na interface ou realizando doações.

Mostrar a importância de conversar com a comunidade, mantendo a contribuição alinhada com os objetivos do projeto, evitando concepções equivocadas e retrabalho. Dessa forma, é importante que o plano de comunicação esteja acessível e os canais ( Fórum, Lista de e-mail, Blog, redes sociais… ) claramente identificados.

Recentemente @fltiago citou uma boa referencia que pode ser adicionada ao guideline.

Levando essas considerações em conta, acredito que podemos tornar a chegada de novos membros mais prazerosa, o que vocês acham? O canal está aberto a sugestões!