Versão do artigo: Enterprise Server 2.17
Creating a default community health file
You can create default community health files, such as CONTRIBUTING and CODE_OF_CONDUCT. Default files will be used for any public repository owned by the account that does not contain its own file of that type.
Sobre arquivos padrão de integridade da comunidade
You can add default community health files to the root of a public repository called .github
that is owned by an organization.
GitHub Enterprise will use and display default files for any public repository owned by the account that does not have its own file of that type in any of the following places:
- 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 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
You can create defaults in your organization for the following community health files:
Arquivo de integridade da comunidade | Descrição |
---|---|
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". |
Issue and pull request templates | 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". |
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". |
You cannot create a default license file. 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
- In the upper-right corner of any page, use the drop-down menu, and select New repository.
- Use the Owner drop-down menu, and select the organization you want to create default files for.
- Digite .github como o nome para seu repositório e uma descrição opcional.
- Escolha tornar o repositório público.
- Selecione Initialize this repository with a README (Inicializar este repositório com um LEIAME).
- Clique em Create Repository (Criar repositório).
- No repositório, crie um dos arquivos compatíveis de integridade da comunidade. Issue templates 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".