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.
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 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 modelos de problema e pull request".
Como adicionar um arquivo CONTRIBUTING
-
Em GitHub, acesse a página principal do repositório.
-
Acima da lista de arquivos, selecione o menu suspenso Adicionar arquivo e clique em Criar arquivo.
Como alternativa, é possível clicar em na exibição em árvore de arquivos à esquerda.
-
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 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, 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óriodocs
.
-
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.
-
Clique em Fazer commit das alterações...
-
No campo "Mensagem do commit", digite uma mensagem curta e relevante que descreva a alteração que você fez no arquivo. Você pode atribuir o commit a mais de um autor na mensagem de commit. Para obter mais informações, confira "Criar um commit com vários autores".
-
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".
-
Clique em Fazer commit de alterações ou em Propor alterações.
Exemplos de diretrizes de contribuição
Caso tenha dúvidas, estes são alguns bons exemplos de diretrizes de contribuição:
- As diretrizes de contribuição do GitHub Docs.
- As diretrizes de contribuição do Ruby on Rails.
- As diretrizes de contribuição do Open Government.
Leitura adicional
- A seção "Como iniciar um projeto de código aberto" dos Guias de Código Aberto
- "Adicionar uma licença a um repositório"