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.

Configurar diretrizes para os contribuidores do repositório

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

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. Para obter mais informações, consulte "Criar arquivo padrão de integridade da comunidade para a organização".

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, navegue até a página principal do repositório.

  2. Above the file list, click Create new file.

    The New file button

  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. At the bottom of the page, type a short, meaningful commit message that describes the change you made to the file. You can attribute the commit to more than one author in the commit message. For more information, see "Creating a commit with multiple co-authors."

    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. If your current branch is master, you should choose to create a new branch for your commit and then create a pull request. For more information, see "Creating a new pull request."

    Opções para fazer commit no branch

  7. Click Propose new file.

    Propose new file button

Exemplos de diretrizes de contribuição

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

Leia mais

Pergunte a uma pessoa

Não consegue encontrar o que procura?

Entrar em contato