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

本文内容

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

关于默认社区健康文件

默认社区运行状况文件是一组预定义文件，提供维护协作型开放源代码项目正常运行所需的指导和模板。 可以将默认社区运行状况文件添加到存储库根目录下或者 docs 或 .github 文件夹中名为 .github 的公共存储库中。 这些文件可帮助实现项目开发和社区交互各个方面的自动化和标准化。 它们对于促进开放源代码项目的透明度、良好实践和协作至关重要。

对于在以下任何位置不含该类型自有文件的帐户所拥有的任何仓库，GitHub 将使用并显示默认文件：

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

例如，在不含自有 CONTRIBUTING 文件的仓库中创建议题或拉取请求的人将会看到指向默认 CONTRIBUTING 文件的链接。 如果存储库在其自己的 .github/ISSUE_TEMPLATE 文件夹中含有任何文件，包括议题模板或 config.yml 文件，则不会使用默认 .github/ISSUE_TEMPLATE 文件夹的内容。

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

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

支持的文件类型

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

社区运行状况文件 | 说明 --- | --- CODE_OF_CONDUCT.md | CODE_OF_CONDUCT 文件定义有关如何参与社区的标准。 有关详细信息，请参阅“为项目添加行为准则”。CONTRIBUTING.md | CONTRIBUTING 文件指示应如何参与你的项目。 有关详细信息，请参阅“设置仓库参与者指南”。讨论类别表单 | 讨论类别表单自定义社区成员在存储库中打开新讨论时可以使用的模板。 有关详细信息，请参阅“创建讨论类别表单”。FUNDING.yml | FUNDING 文件在存储库中显示发起人按钮，以提高开源项目资助选项的可见性。 有关详细信息，请参阅“在仓库中显示赞助者按钮”。 GOVERNANCE.md | GOVERNANCE 文件介绍项目的治理方式。 例如，其中可能会讨论项目角色以及如何做出决策。 问题和拉取请求模板 和 config.yml | 问题和拉取请求模板可自定义和标准化你希望参与者在存储库中打开问题或拉取请求时包含的信息。 有关详细信息，请参阅“关于议题和拉取请求模板。” SECURITY.md | SECURITY 文件阐述了如何报告项目中的安全漏洞。 有关详细信息，请参阅“将安全策略添加到存储库。”SUPPORT.md | SUPPORT 文件介绍在项目中获取帮助的途径。 有关详细信息，请参阅“将支持资源添加到项目”。

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

创建用于默认文件的仓库

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

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

  2. 使用“所有者”下拉菜单，选择要为其创建默认文件的组织或个人帐户。 新 GitHub 存储库的所有者菜单的屏幕截图。 菜单显示两个选项：“octocat”和“github”。

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

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

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

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

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

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