Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.

Esta versão do GitHub Enterprise foi descontinuada em 2021-03-02. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, melhorar a segurança e novos recursos, upgrade to the latest version of GitHub Enterprise. Para ajuda com a atualização, contact GitHub Enterprise support.

Configurar diretrizes para os contribuidores do repositório

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

Neste artigo

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.

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 a organização ou conta de usuário. Para obter mais informações, consulte "Criando um arquivo padrão de integridade da comunidade."

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

Adicionar um arquivo CONTRIBUTING

  1. No GitHub Enterprise Server, navegue até a página principal do repositório.

  2. Acima da lista de arquivos, clique em Create new file (Criar novo arquivo).

    "Criar novo arquivo" botão

  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 arquivo das diretrizes de contribuição não diferenciam maiúsculas de minúsculas e podem ter uma extensão .md ou .txt.

    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, em seguida, digite CONTRIBUTING.
  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."

    Mensagem do commit para sua alteração

  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."

    Opções para fazer commit no branch

  7. Clique em Propose new file.

    Propor botão de novo arquivo

Exemplos de diretrizes de contribuição

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

Leia mais