跳至主要内容

关于问题和拉取请求模板

使用问题和拉取请求模板,您可以自定义并标准化贡献者在您的仓库中打开问题和拉取请求时需要包含的信息。

本文内容

在您的仓库中创建问题和拉取请求模板后,贡献者可以依据仓库的贡献指南使用这些模板来打开问题或描述其拉取请求中的拟议更改。有关向仓库添加贡献指南的更多信息,请参阅 为仓库贡献者设定指南

您可以为您的组织或个人账户创建默认的问题和拉取请求模板。有关更多信息,请参阅 创建默认的社区健康文件

问题模板

当您使用问题模板构建器或问题表单为仓库创建问题模板时,贡献者可以在仓库中打开新问题时选择相应的模板。

Screenshot of the new issue page, with multiple templates to choose from.

当您想在提供打开问题指南的同时允许贡献者指定问题内容时,问题模板非常有用。如果您希望贡献者在打开问题时提供特定的结构化信息,问题表单可以帮助确保您收到所需的信息。

使用模板构建器,您可以为每个模板指定标题和描述,添加模板内容,并将模板提交到默认分支或在仓库中打开拉取请求。模板构建器会自动添加模板在新问题页面显示所需的 YAML 前置标记。有关更多信息,请参阅 为您的仓库配置问题模板

使用问题表单,您可以使用 GitHub 表单模式创建包含网页表单字段的模板。当贡献者使用问题表单打开问题时,表单输入会转换为标准的 markdown 问题评论。您可以指定不同的输入类型并将输入设为必填,以帮助贡献者在仓库中打开可操作的问题。有关更多信息,请参阅 为您的仓库配置问题模板问题表单语法

您可以通过在 .github/ISSUE_TEMPLATE 文件夹中添加 config.yml 文件来自定义人们在仓库中创建新问题时看到的问题模板选择器。有关更多信息,请参阅 为您的仓库配置问题模板

问题模板存储于仓库的默认分支中的隐藏 .github/ISSUE_TEMPLATE 目录下。如果您在其他分支创建模板,协作者将无法使用。问题模板文件名不区分大小写,并且需要 .md 扩展名。使用问题表单创建的模板需要 .yml 扩展名。要显示带有社区概览检查清单中的对号,问题模板必须位于 .github/ISSUE_TEMPLATE 文件夹中,并在 YAML 前置标记中包含有效的 name:about: 键(针对以 .md 文件定义的问题模板)或有效的 name:description: 键(针对以 .yml 文件定义的问题表单)。

您可以创建安全策略,为人们提供报告您项目中安全漏洞的说明。欲了解更多信息,请参见 向您的仓库添加安全策略

拉取请求模板

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

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

有关更多信息,请参阅 为您的仓库创建拉取请求模板

© . This site is unofficial and not affiliated with GitHub, Inc.