Use este arquivo para educar seus usuários sobre como eles podem colaborar com o projeto.
Comece com um parágrafo agradecendo o interesse e instigando os usuários a contribuir como puderem com o projeto, já que nem toda contribuição é em forma de código:
- Criação de logos e ícones;
- Melhoria na documentação;
- Evangelização (divulgação do projeto em redes sociais)
- Triagem de issues;
- etc.
Recomendo fortemente que você tenha um Código de Conduta, mesmo que seu projeto seja tocado por você e seu gato.
A experiência ensina que é melhor estabelecer regras de convivência ANTES que elas sejam necessárias. Comunique a seus colaboradores presentes e futuros a existência de um código de conduta e recomende a sua leitura antes de qualquer colaboração.
Uso e incentivo a adoção do Contributor Covenant como código de conduta para qualquer projeto. O texto em pt-BR pode ser lido aqui.
Defina se seu projeto usa CLA ou DCO para assegurar a originalidade da colaboração recebida, bem como a forma de assinatura desses documentos no escopo do seu projeto.
Informe a seus colaboradores os procedimentos necessários para abrir uma issue. Se não usa o GitHub Issues, indique qual sistema de gestão de issues você usa, como o Jira.
Recomendo que faça uso de modelos de issues, como os de relatório de bugs e de sugestão de funcionalidade que o GitHub Issues sugere, documentando-os exaustivamente sobre como preenchê-los de forma eficiente e eficaz. Os modelos adicionados nesse repositório podem e devem ser adaptados às suas necessidades.
Descreva o ambiente no qual o projeto é desenvolvido. Liste:
- Sistema operacional e versão;
- Ambiente integrado de desenvolvimento;
- Kits de desenvolvimento de software;
- Projetos de terceiros acoplados.
Você não é obrigado a ter esta seção, então se não faz uso de ferramentas externas ao seu IDE, não precisa dela.
Digamos que você use OpenCover para gerar seus relatórios de testes para envio ao Codecov. Use esta subseção para explicar como usar o aplicativo para gerar esses relatórios.
Informe aos colaboradores o fluxo de trabalho que você usa em seu projeto. Há tantos fluxos quantas abordagens de desenvolvimento existem, então fique à vontade para descrever o fluxo que você usa, talvez apoiando-se em documentações oficiais desses fluxos.
O que é mais importante nessa seção é deixar claro como o colaborador pode garantir que o seu trabalho esteja sendo feito da forma esperada, desde a clonagem do projeto até a abertura de Pull Request.
Use esta subseção para descrever como o colaborador pode abrir um Pull Request e garantir que seu código esteja pronto e testado para ser mesclado ao projeto. Novamente, o uso de modelos exaustivamente documentados é amplamente recomendado e esperado. O modelo de Pull Request incluído neste repositório pode e deve ser usado e adaptado às suas necessidades.