Sobre arquivos padrão de integridade da comunidade
Você pode adicionar arquivos padrão de integridade da comunidade à raiz de um repositório público chamado .github
que é de propriedade de uma organização.
GitHub Enterprise usará e exibirá arquivos padrão para qualquer repositório público de propriedade da conta que não tenha seu próprio arquivo desse tipo em nenhum dos seguintes 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. Se um repositório tiver quaisquer arquivos em sua própria pasta .github/ISSUE_TEMPLATE
nenhum conteúdo da pasta padrão .github/ISSUE_TEMPLATE
será usado.
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 sua organização para os seguintes arquivo de integridade da comunidade:
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". |
Modelos de problema e pull request | 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". |
Você não pode criar um arquivo de licença padrã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
- In the upper-right corner of any page, use the drop-down menu, and select New repository.
- Use o menu suspenso Proprietário e selecione a organização para as quais você deseja criar arquivo padrão.
- 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).
- Click Create repository.
- No repositório, crie um dos arquivos compatíveis de integridade da comunidade. Modelos de problema devem estar em uma pasta chamada
.github/ISSUE_TEMPLATE
. Todos os outros arquivos compatíveis devem estar na raiz do repositório. Para obter mais informações, consulte "Criar arquivos".