Sobre arquivos padrão de integridade da comunidade
Você pode adicionar arquivos padrão de saúde da comunidade à raiz de um repositório público denominado .github pertencente a uma organização ou conta de usuário.
GitHub Enterprise Server 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 arquivos na usa própria pasta .github/ISSUE_TEMPLATE, incluindo modelos de problema ou um arquivo config.yml, 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 na sua organização ou conta de usuário para os seguintes arquivos de saúde 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 "Definir diretrizes para contribuidores de repositórios". |
| Modelos de problemas e pull request e 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 problemas e modelos de 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
- No canto superior direito de qualquer página, use o menu suspenso e selecione Novo repositório.
- Use o menu suspenso Proprietário e selecione a organização ou conta de usuário para a qual você deseja criar arquivos padrão.
- Digite .github como o nome para seu repositório e uma descrição opcional.
- Certifique-se de que o status do repositório está definido como Público (um repositório-padrão para arquivos não pode ser privado).
- Selecione Initialize this repository with a README (Inicializar este repositório com um LEIAME).
- Clique Criar repositório.
- No repositório, crie um dos arquivos compatíveis de integridade da comunidade. Modelos de problema e o seu arquivo de configuração deve estar em uma pasta denominada
.github/ISSUE_TEMPLATE. Todos os outros arquivos compatíveis devem estar na raiz do repositório. Para obter mais informações, consulte "Criar arquivos".