Skip to main content

Como criar um arquivo 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 integridade da comunidade a um repositório público chamado .github, na raiz do repositório ou nas pastas docs ou .github.

GitHub Enterprise Cloud 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 arquivos na pasta .github/ISSUE_TEMPLATE, incluindo modelos de problemas ou um arquivo config.yml, nenhum conteúdo da pasta .github/ISSUE_TEMPLATE padrão será usado.

Os arquivos padrão não são incluídos em clones, pacotes ou downloads de repositórios individuais porque são armazenados apenas no repositório .github.

Tipos de arquivo com suporte

Você pode criar padrões na sua conta de organização ou pessoal para os seguintes arquivos de integridade da comunidade:

Arquivo de integridade da comunidade | Descrição --- | --- CODE_OF_CONDUCT.md | Um arquivo CODE_OF_CONDUCT define os padrões de como participar de uma comunidade. Para obter mais informações, confira "Como adicionar um código de conduta ao seu projeto". CONTRIBUTING.md | Um arquivo CONTRIBUTING informa como as pessoas devem contribuir com seu projeto. Para obter mais informações, confira "Como definir diretrizes para colaboradores do repositório". FUNDING.yml | Um arquivo FUNDING exibe um botão de patrocinador no seu repositório para aumentar a visibilidade das opções de financiamento para seu projeto de código aberto. Para obter mais informações, confira "Como exibir um botão de patrocinador no seu repositório". Modelos de problemas e de solicitações de pull e config.yml | Os modelos de problemas e de solicitações de pull personalizam e padronizam as informações que você deseja que os colaboradores incluam ao abrir problemas e solicitações de pull no repositório. Para obter mais informações, confira "Sobre os modelos de problemas e de solicitações de pull". SECURITY.md | Um arquivo SECURITY fornece instruções sobre como relatar uma vulnerabilidade de segurança no projeto. Para obter mais informações, confira "Como adicionar uma política de segurança ao seu repositório". SUPPORT.md | Um arquivo SUPPORT permite que as pessoas descubram as maneiras de obter ajuda com seu projeto. Para obter mais informações, confira "Como adicionar recursos de suporte ao seu 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 para criação de um repositório
  2. Use o menu suspenso Proprietário e selecione a conta de organização ou pessoal para a qual deseja criar arquivos padrão. Menu suspenso Proprietário
  3. Digite .github como o nome do repositório e uma descrição opcional. Campo Criar repositório
  4. Verifique se o status do repositório está definido como Público (um repositório para arquivos padrão não pode ser privado). Botões de opção usados para selecionar o status público ou privado 1. Selecione Inicializar este repositório com um LEIAME. Caixa de seleção Inicializar este repositório com um LEIAME 1. Clique em Criar repositório. Botão usado para criar um repositório
  5. No repositório, crie um dos arquivos compatíveis de integridade da comunidade. Os modelos de problemas e os respectivos arquivos de configuração precisam estar em uma pasta chamada .github/ISSUE_TEMPLATE. Todos os outros arquivos com suporte podem estar na raiz do repositório, na pasta .github ou na pasta docs. Para obter mais informações, confira "Como criar arquivos".