Sobre arquivos padrão de integridade da comunidade
Você pode adicionar arquivos padrão de saúde da comunidade a um repositório público denominado git.hub
na raiz do repositório ou nas pastas docs
ou .github
.
GitHub Enterprise Server usará e exibirá arquivos padrão para qualquer repositório pertencente � conta que não tem seu próprio arquivo desse tipo em nenhum dos seguintes lugares:
- a raiz do repositório
- a pasta
.github
- a pasta
docs
Por exemplo, qualquer pessoa que criar um problema ou pull request em um repositório que não tenha seu próprio arquivo CONTRIBUTING verá um link para o arquivo padrão CONTRIBUTING. Se um repositório tiver quaisquer arquivos em sua própria pasta .github/ISSUE_TEMPLATE
, incluindo modelos de problemas 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 pessoal 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 "Configurar diretrizes para contribuidores de repositório". |
Modelos de problema 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 modelos de problema e pull request". |
SECURITY.md | Um arquivo SECURITY fornece instruções sobre como relatar uma vulnerabilidade de segurança no 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". |
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 pessoal 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 README).
- Clique em Create Repository (Criar repositório).
- No repositório, crie um dos arquivos compatíveis de integridade da comunidade. Modelos de problema e seu arquivo de configuração devem estar em uma pasta chamada
.github/ISSUE_TEMPLATE
. Todos os outros arquivos compatíveis podem estar na raiz do repositório, na pasta.github
ou na pastadocs
. Para obter mais informações, consulte "Criar arquivos".