跳至主要内容

创建默认社区健康文件

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

关于默认社区健康文件

默认社区健康文件是一组预定义的文件,它们提供指导和模板,用于维护健康且协作的开源项目。您可以将默认社区健康文件添加到名为 .github 的公共仓库中,该仓库位于仓库的根目录或 docs.github 文件夹中。这些文件可帮助您自动化和标准化项目开发和社区互动的各个方面。它们对于在开源项目中促进透明度、良好实践和协作至关重要。

对于任何帐户拥有的、在其任何以下位置都没有其自身该类型文件的仓库,GitHub 将使用和显示默认文件

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

例如,任何在没有其自身 CONTRIBUTING 文件的仓库中创建问题或拉取请求的人都会看到指向默认 CONTRIBUTING 文件的链接。如果仓库在其自己的 .github/ISSUE_TEMPLATE 文件夹中包含任何文件,包括问题模板或 _config.yml_ 文件,则不会使用默认 .github/ISSUE_TEMPLATE 文件夹中的任何内容。

默认文件不会出现在文件浏览器或 Git 历史记录中,也不会包含在单个仓库的克隆、包或下载中,因为它们仅存储在 .github 仓库中。

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

支持的文件类型

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

社区健康文件描述
CODE_OF_CONDUCT.mdCODE_OF_CONDUCT 文件定义了如何在社区中互动的标准。有关更多信息,请参阅“向您的项目添加行为准则”。
CONTRIBUTING.mdCONTRIBUTING 文件说明了人们应该如何为您的项目做出贡献。有关更多信息,请参阅“为仓库贡献者设置指南”。
讨论类别表单讨论类别表单自定义了社区成员在仓库中打开新讨论时可用的模板。有关更多信息,请参阅“创建讨论类别表单”。
FUNDING.ymlFUNDING 文件在您的仓库中显示赞助按钮,以提高开源项目的资金选择的可见性。有关更多信息,请参阅“在您的仓库中显示赞助按钮”。
GOVERNANCE.mdGOVERNANCE 文件让人们了解您的项目是如何管理的。例如,它可能会讨论项目角色以及如何做出决策。
问题和拉取请求模板以及 _config.yml_问题和拉取请求模板自定义并标准化您希望贡献者在仓库中打开问题和拉取请求时包含的信息。有关更多信息,请参阅“关于问题和拉取请求模板”。
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. 选择**使用自述文件初始化此仓库**。

  7. 单击**创建仓库**。

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