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

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

在本文中

关于默认社区健康文件

默认社区健康文件是一组预定义的文件，提供指导和模板，用于维护一个健康且协作的开源项目。 这些文件有助于你实现项目开发及社区互动各个方面的自动化和标准化，促进透明度、最佳做法及协作。

可以将默认社区健康文件添加到名为 的存储库中。 存储库 .github 必须是 公共的。

GitHub 将对该账户拥有的任何仓库使用并显示默认文件；如果目标仓库没有其自己的该类型文件，则无论目标仓库的可见性如何，都会这样做。 对于可存储在多个位置的受支持文件， GitHub 请使用以下优先级顺序：

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

如果在当前存储库中找不到相应的文件， GitHub 将使用存储库中的 .github 默认文件。 对于可存储在多个位置的文件，GitHub 遵循与 .github 存储库中相同的优先顺序。

例如，在不含自有 CONTRIBUTING.md 文件的存储库中创建问题或拉取请求的人将会看到 CONTRIBUTING.md 存储库中默认 .github 的链接。 但是，如果存储库在其自己的 .github/ISSUE_TEMPLATE 文件夹中定义有效的问题模板或颁发模板配置，则不会使用默认 .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 文件说明了人们应该如何参与项目。 有关详细信息，请参阅“制定仓库贡献者指南”。
讨论类别表单讨论类别表单可自定义模板，供社区成员在存储库中打开新讨论时使用。 有关详细信息，请参阅“创建讨论类别表单”。
FUNDING.ymlFUNDING 文件在存储库中显示赞助按钮，以提高开放源代码项目的融资选项的可见性。 有关详细信息，请参阅“在代码库中显示赞助按钮”。
问题和拉取请求模板，以及 config.yml__问题和拉取请求模板可自定义和标准化你希望参与者在存储库中打开问题和拉取请求时添加的信息。 有关详细信息，请参阅“关于议题和拉取请求模板”。

如果问题模板设置了标签，则必须在 .github 存储库和将使用该模板的任何存储库中创建该标签。
SECURITY.md安全性文件提供了如何报告项目中的安全漏洞的说明，以及对该文件进行超链接的描述。 有关详细信息，请参阅“将安全策略添加到存储库”。
SUPPORT.mdSUPPORT 文件可让人们了解获得项目帮助的途径。 有关详细信息，请参阅“添加支持资源到项目中”。

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

创建用于默认文件的仓库

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

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

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

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

  1. 在“存储库名称”字段中，键入 .github。
  2. （可选）在“描述”字段中键入描述。
  3. 确保存储库状态设置为 “公共”。 默认文件的存储库不能是专用的。
  4. 将 README 切换为 开启。
  5. 单击“创建存储库”。
  6. 在仓库中，创建一个受支持的社区健康文件。 讨论类别表单必须位于名为 的文件夹中。 议题模板及其配置文件必须位于名为 .github/ISSUE_TEMPLATE 的文件夹中。

FUNDING.yml文件必须位于.github文件夹中。 所有其他支持的文件可能位于存储库 .github 、文件夹或 docs 文件夹的根目录中。 有关详细信息，请参阅“创建新文件”。