Skip to main content

Configurar diretrizes para os contribuidores do repositório

Você pode criar diretrizes para informar como as pessoas devem contribuir com o projeto.

Sobre diretrizes de contribuição

Para ajudar os colaboradores do projeto a fazer um bom trabalho, você pode adicionar um arquivo com diretrizes de contribuição à raiz do repositório de projeto, a docs ou à pasta .github. Quando alguém abrir uma pull request ou criar um problema, verá um link para esse arquivo. O link usado para as diretrizes de contribuição também é exibido na página do repositório contribute. Para ver um exemplo de uma página contribute, confira github/docs/contribute.

diretrizes de contribuição

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 conta de organização ou pessoal . Para obter mais informações, confira "Como criar um arquivo padrão de integridade da comunidade".

Dica: os mantenedores do repositório podem definir diretrizes específicas para problemas criando um modelo de solicitação de pull ou de problema para o repositório. Para obter mais informações, confira "Sobre os modelos de solicitações de pull e de problemas".

Como adicionar um arquivo CONTRIBUTING

  1. No GitHub.com, navegue até a página principal do repositório. 1. Acima da lista de arquivos, usando o menu suspenso Adicionar arquivo, clique em Criar arquivo. "Criar arquivo" no menu suspenso "Adicionar arquivo"
  2. Decida se deseja armazenar suas diretrizes de contribuição na raiz do repositório, em docs ou no diretório .github. 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, confira "Como trabalhar com arquivos que não são de código". Nome do novo arquivo
    • 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, depois, CONTRIBUTING.
    • Se um repositório contiver mais de um arquivo CONTRIBUTING, o arquivo mostrado nos links será escolhido dos locais na seguinte ordem: o diretório .github, o diretório raiz do repositório e, por fim, o diretório docs.
  3. 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.
  4. 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, confira "Como criar um commit com vários coautores". Mensagem de commit para a alteração 1. 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, confira "Como criar uma solicitação de pull". Opções de commit no branch 1. Clique em Propor novo arquivo. Botão Propor novo arquivo

Exemplos de diretrizes de contribuição

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

Leitura adicional