Sobre arquivos padrão de integridade da comunidade
Os arquivos padrão de integridade da comunidade 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 você a automatizar e padronizar vários aspectos do desenvolvimento de 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 público chamado .github
, e o GitHub Enterprise Cloud usará e exibirá arquivos padrão para qualquer repositório de propriedade da conta que não tenha o próprio arquivo desse tipo, na seguinte ordem:
- A pasta
.github
- A raiz do repositório
- A pasta
docs
Se nenhum arquivo correspondente for encontrado no repositório atual, o GitHub Enterprise Cloud usará o arquivo padrão do repositório .github
, seguindo a mesma ordem de precedência.
Por exemplo, qualquer pessoa que criar um problema ou pull request em um repositório que não tenha o próprio arquivo CONTRIBUTING.md
verá um link para o CONTRIBUTING.md
padrão do repositório .github
. No entanto, se um repositório tiver arquivos na própria pasta .github/ISSUE_TEMPLATE
, como modelos de problema ou um arquivo _config.yml
, nenhum conteúdo da pasta .github/ISSUE_TEMPLATE
padrão será usado. Isso permite que os mantenedores de repositório substituam os arquivos padrão por modelos ou conteúdos 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 aparecerão 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 obter mais informações, confira "Sobre perfis de comunidade para repositórios públicos".
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, confira "Adicionar um código de conduta ao seu projeto". |
CONTRIBUTING.md | Um arquivo CONTRIBUTING comunica como as pessoas devem contribuir com seu projeto. Para obter mais informações, 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 obter mais informações, 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 de software livre. Para obter mais informações, confira "Exibir botão de patrocinador no repositório". |
GOVERNANCE.md | Um arquivo GOVERNANCE permite que as pessoas saibam como seu projeto é controlado. Por exemplo, ele pode discutir as funções de projeto e como as decisões são tomadas. |
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 obter mais informações, confira "Sobre modelos de problema e pull request". |
SECURITY.md | Um arquivo SECURITY fornece instruções sobre como relatar uma vulnerabilidade de segurança em seu projeto e uma descrição com um hiperlink para o arquivo. Para obter mais informações, 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 obter mais informações, 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
-
No canto superior direito de qualquer página, selecione e clique em Novo repositório.
-
Use o menu suspenso Proprietário e selecione a conta de organização ou pessoal para a qual deseja criar arquivos padrão.
-
No campo "Nome do repositório", digite .github.
-
Opcionalmente, no campo "Descrição", digite uma descrição.
-
Verifique se o status do repositório está definido como Público. Um repositório para arquivos padrão não pode ser privado.
-
Selecione Inicializar este repositório com um LEIAME.
-
Clique em Criar repositório.
-
No repositório, crie um dos arquivos compatíveis de integridade da comunidade. Os modelos de problemas e seu arquivo de configuração devem 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 pastadocs
. Para obter mais informações, confira "Criar arquivos".