创建默认的社区健康文件

您可以创建默认的社区健康文件，例如 CONTRIBUTING 和 CODE_OF_CONDUCT。默认文件将用于账户拥有的任何仓库中未包含该类型文件的情况。

本文内容

关于默认社区健康文件

默认社区健康文件是一组预定义的文件，为维护健康且协作的开源项目提供指导和模板。这些文件帮助您自动化并标准化项目开发和社区互动的各个方面，促进透明度、良好实践和协作。

您可以将默认社区健康文件添加到一个名为 .github 的 公开 仓库，GitHub 将按照以下顺序为该账户拥有且未自行提供该类型文件的任何仓库使用并显示默认文件

  • .github 文件夹
  • 仓库根目录
  • docs 文件夹

如果在当前仓库中未找到相应的文件，GitHub 将从 .github 仓库使用默认文件，遵循相同的优先级顺序。

注意

.github 仓库必须是 公开 的，才能在整个组织范围内应用大多数默认社区健康文件。不支持私有的 .github 仓库。

例如，在没有自己的 CONTRIBUTING.md 文件的仓库中创建 issue 或 pull request 的任何人，都将看到指向来自 .github 仓库的默认 CONTRIBUTING.md 的链接。然而，如果仓库在其自身的 .github/ISSUE_TEMPLATE 文件夹中放置了任何文件，例如 issue 模板或 _config.yml 文件，则不会使用默认 .github/ISSUE_TEMPLATE 文件夹中的任何内容。这使得仓库维护者能够在每个仓库层面用特定的模板或内容覆盖默认文件。

将文件存储在 .github 仓库中，只需在一个地方即可更改默认内容。此外，这些文件不会出现在各个仓库的文件浏览器或 Git 历史中，也不会包含在它们的克隆、打包或下载中。

作为仓库维护者，您可以使用社区标准检查清单，查看您的项目是否符合推荐的社区标准，从而帮助人们使用和贡献您的项目。欲了解更多信息，请参阅 关于公共仓库的社区简介。

关于安全策略

在有人报告项目中的安全漏洞后，您可以使用 GitHub Security Advisories 公开、修复并发布有关该漏洞的信息。有关在 GitHub 上报告和披露漏洞的流程的更多信息，请参阅 关于安全漏洞的协同披露。有关仓库安全建议的更多信息，请参阅 关于仓库安全建议。

要查看真实的 SECURITY.md 文件示例，请访问 https://github.com/electron/electron/blob/main/SECURITY.md。

支持的文件类型

您可以在组织或个人账户中为以下社区健康文件创建默认文件

社区健康文件描述
CODE_OF_CONDUCT.mdCODE_OF_CONDUCT 文件定义了在社区中如何互动的标准。欲了解更多信息，请参阅 向项目添加行为准则。
CONTRIBUTING.mdCONTRIBUTING 文件说明了人们应如何为您的项目贡献。欲了解更多信息，请参阅 为仓库贡献者设定指南。
Discussion category forms讨论类别表单自定义了社区成员在仓库中发起新讨论时可使用的模板。欲了解更多信息，请参阅 创建讨论类别表单。
FUNDING.ymlFUNDING 文件在您的仓库中显示赞助按钮，以提升开源项目的筹资选项的可见性。欲了解更多信息，请参阅 在仓库中显示赞助按钮。
GOVERNANCE.mdGOVERNANCE 文件让人们了解您的项目是如何治理的。例如，它可能会讨论项目角色以及决策制定方式。
Issue 和 Pull Request 模板以及 config.ymlIssue 和 Pull Request 模板可自定义并标准化您希望贡献者在仓库中打开 issue 和 pull request 时提供的信息。欲了解更多信息，请参阅 关于 Issue 和 Pull Request 模板。

如果 Issue 模板设置了标签，则该标签必须在您的 .github 仓库以及使用该模板的所有仓库中创建。
SECURITY.mdSECURITY 文件提供了在项目中报告安全漏洞的说明以及指向该文件的超链接描述。欲了解更多信息，请参阅 向仓库添加安全策略。
SUPPORT.mdSUPPORT 文件让人们了解获取项目帮助的方式。欲了解更多信息，请参阅 向项目添加支持资源。

您无法创建默认的许可证文件。许可证文件必须添加到各个仓库，以便在克隆、打包或下载项目时包含该文件。

为默认文件创建仓库

  1. 在任意页面的右上角，选择，然后点击 新建仓库。

    Screenshot of a GitHub dropdown menu showing options to create new items. The menu item "New repository" is outlined in dark orange.

  2. 使用 所有者 下拉菜单，选择您想为其创建默认文件的组织或个人账户。

    Screenshot of the owner menu for a new GitHub repository. The menu shows two options, octocat and github.

  3. 在 “仓库名称” 字段中，输入 .github。

  4. 可选地，在 “描述” 字段中输入描述。

  5. 确保仓库状态设置为 公开。默认文件的仓库不能设为私有。

  6. 将 Add README 切换为 On。

  7. 点击 创建仓库。

  8. 在仓库中创建支持的社区健康文件之一。Issue 模板及其配置文件必须放在名为 .github/ISSUE_TEMPLATE 的文件夹中。所有其他支持的文件可以放在仓库根目录、.github 文件夹或 docs 文件夹中。欲了解更多信息，请参阅 创建新文件。

© . This site is unofficial and not affiliated with GitHub, Inc.