我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

关于议题和拉取请求模板

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

本文内容

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

您可以为组织创建默认议题和拉取请求模板。 更多信息请参阅“为组织创建默认社区健康文件”。

议题模板

使用默认构建器为仓库创建议题模板后,贡献者在仓库中打开新议题时便可使用该模板。

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

使用模板构建器,可以指定每个模板的标题和描述,添加模板内容,然后提交模板到默认分支或在仓库中打开拉取请求。 模板构建器会自动添加模板显示于新议题页面所需的 YAML 扉页标记。 For more information, see "Configuring issue templates for your repository."

您可以通过添加一个 config.yml 文件到 .github/ISSUE_TEMPLATE 文件夹,来自定义在仓库中创建新议题时所看到的议题模板选择器。 For more information, see "Configuring issue templates for your repository."

议题模板存储在仓库的默认分支的隐藏目录 .github/ISSUE_TEMPLATE 中。 如果您在另一个分支中创建模板,协作者将无法使用。 议题模板文件名不区分大小写,并且需要 .md 扩展名。 To be included in the community profile checklist, issue templates must be located in the .github/ISSUE_TEMPLATE folder and contain valid name: and about: YAML front matter.

可以使用旧议题模板工作流程在 Markdown 中手动创建单一议题模板,然后项目贡献者将自动在议题中看到模板的内容。 不过,我们建议使用升级的多议题模板构建器来创建议题模板。 有关旧工作流程的更多信息,请参阅"手动为仓库创建单一议题模板"。

You can create a security policy to give people instructions for responsibly reporting security vulnerabilities in your project. For more information, see "Adding a security policy to your repository."

拉取请求模板

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

示例拉取请求模板

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

更多信息请参阅"为仓库创建拉取请求模板"。

问问别人

找不到要找的内容?

联系我们