创建默认的社区运行状况文件

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

本文内容

关于默认社区健康文件

默认社区运行状况文件是一组预定义文件，提供维护协作型开放源代码项目正常运行所需的指导和模板。 这些文件有助于你实现项目开发及社区互动各个方面的自动化和标准化，促进透明度、最佳做法及协作。

可以将默认的社区运行状况文件添加到一个名为 .github 的公共仓库中，并且 GitHub 将按照以下顺序为该帐户所拥有的任何仓库（若其自身没有该类型的文件）使用并显示默认文件：

  • .github 文件夹
  • 存储库的根文件夹
  • docs 文件夹

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

例如，任何人在一个没有自己的 CONTRIBUTING.md 文件的仓库中创建问题或拉取请求时，都将会看到一个指向来自 .github 仓库的默认 CONTRIBUTING.md 的链接。 然而，如果一个仓库在其自身的 .github/ISSUE_TEMPLATE 文件夹中有任何文件，比如问题模板或 _config.yml 文件，那么默认的 .github/ISSUE_TEMPLATE 文件夹中的任何内容都不会被使用。 这使得仓库维护者能够基于每个仓库的具体情况，用特定的模板或内容来替代默认文件。

将文件存储在 .github 仓库中，只需在一个位置对默认设置进行更改。 此外，它们不会出现在单个仓库的文件浏览器或 Git 历史记录中，也不会包含在其克隆、包或下载中。

作为存储库维护员，你可使用社区标准清单来检查项目是否符合建议的社区标准，以帮助人们使用和参与你的项目。 有关详细信息，请参阅“关于公共仓库的社区资料”。

支持的文件类型

可以在组织或个人帐户中为以下社区运行状况文件创建默认内容：

社区健康文件说明
CODE_OF_CONDUCT.md__CODE_OF_CONDUCT 文件定义如何参与社区的标准。 有关详细信息，请参阅“为项目添加行为准则”。
CONTRIBUTING.md__CONTRIBUTING 文件说明了人们应该如何参与项目。 有关详细信息，请参阅“设置仓库参与者指南”。
讨论类别表单讨论类别表单可自定义模板，供社区成员在存储库中打开新讨论时使用。 有关详细信息，请参阅“创建讨论类别表单”。
FUNDING.yml__FUNDING 文件在存储库中显示赞助按钮，以提高开源项目筹资选项的可见性。 有关详细信息，请参阅“在仓库中显示赞助者按钮”。
GOVERNANCE.mdGOVERNANCE 文件让人们了解项目是如何治理的。 例如，其中可能会讨论项目角色以及如何做出决策。
问题和拉取请求模板和 config.yml__问题和拉取请求模板可自定义和标准化你希望参与者在存储库中打开问题和拉取请求时添加的信息。 有关详细信息，请参阅“关于议题和拉取请求模板”。
SECURITY.md__安全文件提供了有关如何报告项目中的安全漏洞以及如何描述超链接文件的说明。 有关详细信息，请参阅“将安全策略添加到存储库”。
SUPPORT.md__SUPPORT 文件可让人们了解获得项目帮助的途径。 有关详细信息，请参阅“将支持资源添加到项目”。

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

创建用于默认文件的仓库

  1. 在任何页面的右上角，选择 ，然后单击“新建存储库”。

    GitHub 下拉菜单的屏幕截图，其中显示了用于创建新项的选项。 菜单项“新建存储库”用深橙色框标出。

  2. 使用“所有者”下拉菜单，选择要为其创建默认文件的组织或个人帐户。****

    新 GitHub 存储库的所有者菜单的屏幕截图。 菜单显示两个选项：“octocat”和“github”。

  3. 在“存储库名称”字段中，键入 .github。

  4. （可选）在“描述”字段中键入描述。

  5. 确保存储库状态设置为“公共”。 默认文件的存储库不能是专用的。

  6. 选择“使用 README 初始化此存储库”。

  7. 单击“创建存储库”。

  8. 在仓库中，创建一个受支持的社区健康文件。 议题模板及其配置文件必须位于名为 .github/ISSUE_TEMPLATE 的文件夹中。 所有其他支持的文件可能位于存储库根目录、.github 文件夹或 docs 文件夹中。 有关详细信息，请参阅“创建新文件”。