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.

Criar um arquivo padrão de integridade da comunidade para sua organização

Você pode criar arquivos padrão de integridade da comunidade, como CONTRIBUTING e CODE_OF_CONDUCT, para sua organização. Os arquivos padrão serão usados para qualquer repositório público na organização que não contenha seu próprio arquivo desse tipo.

Neste guia

Sobre arquivos padrão de integridade da comunidade

Você pode adicionar arquivos padrão de integridade da comunidade para sua organização à raiz de um repositório público chamado .github cuja propriedade é da organização.

O GitHub vai usar e exibir arquivos padrão para qualquer repositório público na organização que não tenha o próprio arquivo desse tipo em algum destes locais:

  • a raiz do repositório
  • a pasta .github
  • a pasta docs

Por exemplo, qualquer pessoa que cria um problema ou uma pull request em um repositório público que não tem o próprio arquivo CONTRIBUTING verá um link para o arquivo CONTRIBUTING padrão. If a repository has any files in its own .github/ISSUE_TEMPLATE folder, including issue templates or a config.yml file, none of the contents of the default .github/ISSUE_TEMPLATE folder will be used.

Os arquivos padrão não são incluídos em clones, pacotes ou downloads de repositórios individuais, pois eles são armazenados somente no repositório .github.

Tipos de arquivo compatíveis

Você pode criar padrões em toda a organização para os seguintes arquivos de integridade da comunidade:

Arquivo de integridade da comunidade Descrição
CODE_OF_CONDUCT.md Um arquivo CODE_OF_CONDUCT define os padrões de como ingressar em uma comunidade. Para obter mais informações, consulte "Adicionar um código de conduta ao projeto".
CONTRIBUTING.md Um arquivo CONTRIBUTING comunica como as pessoas devem contribuir com o seu projeto. Para obter mais informações, consulte "Configurar diretrizes para contribuidores de repositório".
FUNDING.yml Um arquivo FUNDING exibe um botão de patrocinador no repositório para aumentar a visibilidade das opções de financiamento para seu projeto de código aberto. Para obter mais informações, consulte "Exibir um botão de patrocinador no seu repositório".
Issue and pull request templates and config.yml Os modelos de problema e pull request personalizam e padronizam as informações que você deseja que contribuidores incluam quando eles abrem problemas e pull requests no seu repositório. Para obter mais informações, consulte "Sobre modelos de problema e pull request".
SECURITY.md Um arquivo SECURITY fornece instruções sobre como relatar com responsabilidade uma vulnerabilidade de segurança em seu projeto. Para obter mais informações, consulte "Adicionar uma política de segurança ao seu repositório".
SUPPORT.md Um arquivo SUPPORT permite que as pessoas conheçam maneiras de obter ajudar com seu projeto. Para obter mais informações, consulte "Adicionar recursos de suporte ao projeto".

Não é possível criar um arquivo de licença padrão para sua organização. Os arquivos de licença devem ser adicionados a repositórios individuais para que o arquivo seja incluído quando um projeto for clonado, empacotado ou baixado.

Criar um repositório para arquivos padrão

  1. In the upper-right corner of any page, use the drop-down menu, and select New repository.

    Drop-down with option to create a new repository

  2. Use o menu suspenso Owner (Proprietário) e selecione a organização para a qual deseja criar arquivos padrão.

    Menu suspenso Owner (Proprietário)

  3. Digite .github como o nome para seu repositório e uma descrição opcional.

    Campo Create repository (Criar repositório)

  4. Escolha tornar o repositório público.

    Botões de opção para selecionar status privado ou público

  5. Selecione Initialize this repository with a README (Inicializar este repositório com um LEIAME).

    Caixa de seleção Initialize this repository with a README (Inicializar este repositório com um LEIAME)

  6. Clique em Create Repository (Criar repositório).

  7. No repositório, crie um dos arquivos compatíveis de integridade da comunidade. Issue templates and their configuration file must be in a folder called .github/ISSUE_TEMPLATE. Todos os outros arquivos compatíveis devem estar na raiz do repositório. Para obter mais informações, consulte "Criar arquivos".

Pergunte a uma pessoa

Não consegue encontrar o que procura?

Entrar em contato