Skip to main content

此版本的 GitHub Enterprise 将停止服务 2023-01-18. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

关于议题和拉取请求模板

利用议题和拉取请求模板,可以自定义和标准化您希望贡献者在您的仓库中打开议题和拉取请求时加入的信息。

在仓库中创建议题和拉取请求后,贡献者可以根据仓库的参与指南使用模板打开议题或描述其拉取请求中提议的更改。 有关将贡献指南添加到存储库的详细信息,请参阅“为存储库贡献者设置准则”。

你可以为组织或个人帐户创建默认问题和拉取请求模板。 有关详细信息,请参阅“创建默认社区运行状况文件”。

议题模板

当你使用问题模板构建器 为存储库创建问题模板时,贡献者可以在存储库中开立新问题时选择合适的模板。

显示议题模板选项的新议题页面

当您想为开设议题提供指导,同时允许贡献者指定议题的内容时,议题模板很有用。

使用模板构建器,可以指定每个模板的标题和描述,添加模板内容,然后提交模板到默认分支或在仓库中打开拉取请求。 模板构建器会自动添加模板显示于新议题页面所需的 YAML 扉页标记。 有关详细信息,请参阅“为存储库配置问题模板”。

可通过向 .github/ISSUE_TEMPLATE 文件夹添加 config.yml 文件来自定义用户在存储库中创建新议题时看到的议题模板选择器。 有关详细信息,请参阅“为存储库配置问题模板”。

问题模板存储在存储库的默认分支中的一个 .github/ISSUE_TEMPLATE 隐藏目录中。 如果您在另一个分支中创建模板,协作者将无法使用。 问题模板文件名不区分大小写,且需要 .md 扩展名。 要包含在社区配置文件清单中,问题模板必须位于 .github/ISSUE_TEMPLATE 文件夹中,并且包含有效的 name:about: YAML 前页。

可以使用旧议题模板工作流程在 Markdown 中手动创建单一议题模板,然后项目贡献者将自动在议题中看到模板的内容。 但是,我们建议使用已升级的多个问题模板构建器来创建问题模板。 有关旧工作流的详细信息,请参阅“为存储库手动创建单个问题模板”。

您可以创建安全策略,向人们提供有关报告项目中安全漏洞的说明。 有关详细信息,请参阅“向存储库添加安全策略。”

拉取请求模板

将拉取请求模板添加到仓库后,项目贡献者会自动在拉取请求正文中看到模板的内容。

示例拉取请求模板

必须在仓库的默认分支中创建模板。 在其他分支创建的模板无法供协作者使用。 你可以将拉取请求模板存储在存储库的可见根目录的 docs 文件夹或 .github 隐藏目录中。 拉取请求模板文件名不区分大小写,且具有 .md 或 .txt 等扩展名 。

有关详细信息,请参阅“为存储库创建拉取请求模板”。