Skip to main content

此版本的 GitHub Enterprise 已停止服务 2022-06-03. 即使针对重大安全问题,也不会发布补丁。 要获得更好的性能、改进的安全性和新功能,请升级到 GitHub Enterprise 的最新版本。 如需升级方面的帮助,请联系 GitHub Enterprise 支持

创建默认社区健康文件

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

关于默认社区健康文件

您可以将默认社区健康文件添� 到仓库� �目录下或者 docs.github 文件夹中名为 .github 的公共仓库中。

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

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

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

默认文件不包含在各个仓库的克隆、包或下载中,� 为它们只存储在 .github 仓库中。

支持的文件类型

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

社区健康文件描述
CONTRIBUTING.mdCONTRIBUTING 文件说明人们应如何参与您的项目。 更多信息请参阅“设置仓库参与者指南”。
议题和拉取请求模板 和 config.yml议题和拉取请求模板可自定义和� �准化您希望贡献者在您的仓库中打开议题和拉取请求时� 入的信息。 更多信息请参阅“关于议题和拉取请求模板”。
SECURITY.mdSECURITY 文件说明如何报告项目中的安全漏洞。 更多信息请参阅“添� 安全政策到仓库”。
SUPPORT.mdSUPPORT 文件告知获取项目相关帮助的方式。 更多信息请参阅“为项目添� 支持资源”。

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

创建用于默认文件的仓库

  1. 在任何页面的右上角,使用 下拉菜单选择 New repository(新建仓库)带有创建新仓库选项的下拉菜单
  2. 使用 Owner(所有者) 下拉菜单选择要为其创建默认文件的组织 或个人帐户。 所有者下拉菜单
  3. 键入 .github 作为仓库的名称,可选择键入说明。 创建仓库字段
  4. 确保存储库状态设置为公共(默认文件的仓库不能是私有的)。 用于选择机密或公开状态的单选按钮
  5. 选择 Initialize this repository with a README(使用自述文件初始化此仓库)使用自述文件初始化此仓库复选框
  6. 单击 Create repository(创建仓库)创建仓库的按钮
  7. 在仓库中,创建一个受支持的社区健康文件。 议题模板及其配置文件 必须在一个名为 .github/ISSUE_TEMPLATE 的文件夹中。 所有其他支持的文件可能在仓库� �目录、.github 文件夹或 docs 文件夹中。 更多信息请参阅“创建新文件”。