Criando arquivos padrão de integridade da comunidade

Você pode criar arquivos padrão de integridade da comunidade, como CONTRIBUTING e CODE_OF_CONDUCT. Os arquivos padrão serão usados para qualquer repositório pertencente à conta que não contém seu próprio arquivo desse tipo.

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 em sua organização ou conta de usuário para os seguintes arquivo de integridade da comunidade:

Arquivo de integridade da comunidadeDescrição
CONTRIBUTING.mdUm 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.ymlOs 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.mdUm 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.mdUm 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

  1. No canto superior direito de qualquer página, use o menu suspenso e selecione Novo repositório. Menu suspenso com a opção de criar um novo repositório
  2. Use o menu suspenso Proprietário e selecione a organização ou conta de usuário para as quais você deseja criar arquivo 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. 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). 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 README). Caixa de seleção Initialize this repository with a README (Inicializar este repositório com um README)
  6. Clique em Create Repository (Criar repositório). Button to create repository
  7. 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 pasta docs. Para obter mais informações, consulte "Criar arquivos".

Esse documento ajudou você?

Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.