Requisitos do Repositório

Estrutura

Acreditamos que um repositório de código que possui uma boa documentação facilitará a adesão de novos contribuidores e tornará a experiência da comunidade melhor. Por isso, definimos uma estrutura básica para ser seguida:

  • README.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • LICENSE

Você pode checar mais detalhes de cada arquivo no artigo "Iniciando um Projeto Open Source" da Open Source Guide.

README.MD

O README.MD é o primeiro documento visto quando se entra no repositório, por isso é de suma importância que o mesmo responda pelo menos às seguintes perguntas:

  • O que esse projeto faz?
  • Por onde começo?
  • Como posso conseguir ajuda, se eu precisar?

Você pode tratar de outras questões mais especificas do seu repositório, como se há outros repositórios associados ou como os mantenedores lidam com contribuições.

CODE_OF_CONDUCT.md

O código de conduta ajuda a criar regras básicas acerca do comportamento esperado dos participantes do seu projeto. É de suma importância que você garanta um ambiente saudável e respeitoso para toda a comunidade em torno do seu repositório.

Você não precisa escrever o seu próprio código de conduta do zero; é possível e recomendado adaptar os já existentes, como o do Contributor Covenant, que também possui tradução para português.

CONTRIBUTING.md

O CONTRIBUTING explica aos seus potenciais contribuidores como participar do projeto e também pode comunicar suas expectativas de padrão de contribuição. Pode conter informações como:

  • Como abrir relatório de bug ou feature (issue);
  • Como configurar seu ambiente;
  • Os tipos de contribuição que se espera receber;
  • Como abrir uma sugestão de código (pull request).

Use um tom acolhedor, pois lembre que você está se comunicando com possivelmente um(a) contribuidor(a) de primeira viagem!

LICENSE

Uma licença garante a distribuição e acesso do seu repositório, mas também te protege de situações legais problemáticas, como a cópia. Você não precisa escrever uma licença do zero! Recomenda-se adicionar uma das existentes que mais se adapta ao seu projeto. Para descobrir qual licença usar, recomendamos seguir esse guia.

Dicas

  • Se sua ferramenta permitir, use labels para categorizar issues e pull requests;
  • Crie templates de issue e pull requests para incentivar descrições claras e concisas;
  • Você pode incluir ferramentas de CI/CD (integração/entrega contínuas) para facilitar executar testes no repositório, como também o procedimento de deploy.