Como criar um arquivo padrão de integridade da comunidade

Sobre arquivos padrão de integridade da comunidade

Os arquivos de integridade da comunidade padrão são um conjunto de arquivos predefinidos que fornecem diretrizes e modelos para manter um projeto de código aberto íntegro e colaborativo. Esses arquivos ajudam a automatizar e padronizar vários aspectos do desenvolvimento do seu projeto e da interação com a comunidade, promovendo transparência, boas práticas e colaboração.

Você pode adicionar arquivos padrão de integridade da comunidade a um repositório chamado .github. Para um organização com usuários gerenciados, o .github repositório deve ser interno. Para todas as outras contas, o .github repositório deve ser público.

GitHub usará e exibirá arquivos padrão para qualquer repositório de propriedade da conta, independentemente da visibilidade do repositório de destino, que não tenha seu próprio arquivo desse tipo. Para arquivos com suporte que podem ser armazenados em mais de um local, GitHub usa a seguinte ordem de precedência:

• A pasta .github
• A raiz do repositório
• A pasta docs

Se nenhum arquivo correspondente for encontrado no repositório atual, GitHub usará o arquivo padrão do .github repositório. Para arquivos que podem ser armazenados em mais de um local, GitHub segue a mesma ordem de precedência no .github repositório.

Por exemplo, qualquer pessoa que criar um problema ou solicitação de pull em um repositório que não tenha seu próprio arquivo CONTRIBUTING.md, será exibido um link para o arquivo padrão CONTRIBUTING.md do repositório .github. No entanto, se um repositório definir modelos de issue válidos ou a configuração de modelos de issue em sua própria pasta .github/ISSUE_TEMPLATE, nenhum conteúdo da pasta padrão .github/ISSUE_TEMPLATE será usado. Isso permite que os mantenedores de repositório substituam os arquivos padrão por modelos ou conteúdo específicos por repositório.

Armazenar os arquivos no repositório .github permite fazer alterações nos padrões em um só lugar. Além disso, eles não serão exibidos no navegador de arquivos nem no histórico do Git dos repositórios individuais, e não estão incluídos em clones, pacotes ou downloads.

Como um mantenedor de repositórios, use a lista de verificação de padrões da comunidade para ver se o projeto atende aos padrões recomendados da comunidade de modo a ajudar as pessoas a usar e contribuir com seu projeto. Para saber mais, confira Sobre perfis de comunidade para repositórios públicos.

Sobre políticas de segurança

Depois que alguém relatar uma vulnerabilidade de segurança em seu projeto, você poderá usar GitHub Security Advisories para divulgar, corrigir e publicar informações sobre a vulnerabilidade. Para obter mais informações sobre o processo de relatar e divulgar vulnerabilidades em GitHub, consulte Divulgação coordenada de vulnerabilidades de segurança. Para saber mais sobre os avisos de segurança do repositório, confira Avisos de segurança do repositório.

Para obter um exemplo de um arquivo SECURITY.md real, confira https://github.com/electron/electron/blob/main/SECURITY.md.

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 padrões de como se envolver em uma comunidade. Para obter mais informações, consulte Adicionar um código de conduta ao seu projeto.
CONTRIBUTING.md	Um arquivo CONTRIBUTING comunica como as pessoas devem contribuir com seu projeto. Para saber mais, confira Configurar diretrizes para os contribuidores do repositório.
Formulários de categoria de discussão	Os formulários de categoria de discussão personalizam os modelos disponíveis para os membros da comunidade usarem quando abrirem novas discussões em seu repositório. Para saber mais, confira Como criar formulários de categoria de discussão.
FUNDING.yml	Um arquivo FUNDING exibe um botão de patrocinador em seu repositório para aumentar a visibilidade das opções de financiamento para seu projeto código aberto. Para saber mais, confira Exibir botão de patrocinador no repositório.
Modelos de problema e de solicitação de pull e config.yml	Os modelos de solicitação de emissão e pull personalizam e padronizam as informações que você deseja que os colaboradores incluam quando abrirem problemas e efetuar pull de solicitações em seu repositório. Para saber mais, confira Sobre modelos de problema e pull request. Se um modelo de problema definir um rótulo, ele deverá ser criado em seu repositório .github e nos repositórios em que o modelo será usado.
SECURITY.md	Um arquivo SECURITY fornece instruções de como informar uma vulnerabilidade de segurança em seu projeto e uma descrição com um hiperlink para o arquivo. Para saber mais, confira Adicionar uma política de segurança a um repositório.
SUPPORT.md	Um arquivo SUPPORT permite que as pessoas saibam sobre maneiras de obter ajuda com seu projeto. Para saber mais, confira 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, selecione e clique em Novo 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.

1. No campo "Nome do repositório", digite .github.
2. Opcionalmente, no campo "Descrição", digite uma descrição.
3. Se você estiver criando o repositório para um organização com usuários gerenciados, defina o status do repositório como Interno. Para qualquer outra conta, defina o status como Público. Um repositório para arquivos padrão não pode ser privado.
4. Alternar Adicionar LEIAME para Ativado.
5. Clique em Criar repositório.
6. No repositório, crie um dos arquivos compatíveis de integridade da comunidade. Os formulários de categoria de discussão devem estar em uma pasta chamada .github/DISCUSSION_TEMPLATE. Os modelos de problemas e seu arquivo de configuração devem estar em uma pasta chamada .github/ISSUE_TEMPLATE. Um FUNDING.yml arquivo deve estar na .github pasta. Todos os outros arquivos com suporte podem estar na raiz do repositório, da .github pasta ou da docs pasta. Para saber mais, confira Criar novos arquivos.