Configurar diretrizes para os contribuidores do repositório

Sobre diretrizes de contribuição

Para ajudar os contribuidores do projeto a fazer um bom trabalho, você pode adicionar um arquivo com diretrizes de contribuição às pastas raiz, docs ou .github do repositório do projeto. Quando alguém abrir uma pull request ou criar um problema, verá um link para esse arquivo. O link para as diretrizes de contribuição também aparece na página contribuir do seu repositório. Para obter um exemplo da página de contribuir, consulte github/docs/contribua.

Para o proprietário do repositório, as diretrizes de contribuição são uma forma de informar como as pessoas devem contribuir.

Para contribuidores, as diretrizes ajudam a verificar se eles estão enviando pull requests corretas e abrindo problemas úteis.

Para proprietários e contribuidores, as diretrizes de contribuição economizam tempo e evitam aborrecimentos causados por pull requests ou problemas incorretos que precisam ser rejeitados e enviados novamente.

Você pode criar diretrizes de contribuição padrão para sua organização ou conta de usuário. Para obter mais informações, consulte "Criando um arquivo padrão de integridade da comunidade."

Adicionar um arquivo CONTRIBUTING

1. No GitHub Enterprise Server, navegue até a página principal do repositório.
2. Acima da lista de arquivos, utilizando o menu suspenso Add file (Adicionar arquivo), clique em Create new file (Criar novo arquivo).
3. Decida se deseja armazenar as diretrizes de contribuição no diretório root, docs ou .github do repositório. Em seguida, no campo de nome do arquivo, digite o nome e a extensão do arquivo. Os nomes de arquivos com diretrizes de contribuição não são sensíveis a maiúsculas de minúsculas. Os arquivos são renderizados no formato de texto rich se a extensão do arquivo estiver em um formato compatível. Para obter mais informações, consulte "Trabalhando com arquivos sem código".
   • Para tornar as diretrizes de contribuição visíveis no diretório raiz do repositório, digite CONTRIBUTING.
   • Para tornar as diretrizes de contribuição visíveis no diretório docs do repositório, digite docs/ para criar o diretório e, em seguida, digite CONTRIBUTING.
   • Se um repositório contiver mais de um arquivo CONTRIBUTING, o arquivo mostrado em links será escolhido entre locais na seguinte ordem: diretório do .github, em seguida, o diretório raiz do repositório e, finalmente, o diretório de docs.
4. Adicione as diretrizes de contribuição ao novo arquivo. Elas podem conter:
   • Etapas para criar bons problemas ou pull requests.
   • Links para documentações externas, listas de distribuição ou um código de conduta.
   • Expectativas de comportamento e da comunidade.
5. No final da página, digite uma mensagem de commit curta e significativa que descreva a alteração feita no arquivo. Você pode atribuir o commit a mais de um autor na mensagem de commit. Para obter mais informações, consulte "Criar um commit com vários co-autores."
6. Abaixo dos campos de mensagem do commit, opte por adicionar o commit ao branch atual ou a um novo branch. Se seu branch atual for o branch-padrão, você deverá optar por criar um novo branch para seu commit e, em seguida, criar um pull request. Para obter mais informações, consulte "Criar uma nova pull request."
7. Clique em Propose new file.

Exemplos de diretrizes de contribuição

Caso tenha dúvidas, estes são alguns bons exemplos de diretrizes de contribuição:

• Diretrizes de contribuição do editor Atom.
• Diretrizes de contribuição do Ruby on Rails.
• Diretrizes de contribuição do Open Government.

Leia mais

• Seção "Iniciar um projeto de código aberto" de Guias de código aberto
• "Adicionar uma licença a um repositório"