跳至主要内容

关于 issue 和 pull request 模板

使用 issue 和 pull request 模板,你可以自定义和标准化你希望贡献者在你的仓库中打开 issue 和 pull request 时包含的信息。

在你的仓库中创建 issue 和 pull request 模板后,贡献者可以使用这些模板来打开 issue 或根据仓库的贡献指南描述他们 pull request 中的更改建议。有关向仓库添加贡献指南的更多信息,请参阅 "为仓库贡献者设置指南。"

您可以为您的组织或个人帐户创建默认的 Issue 和 Pull Request 模板。有关更多信息,请参阅“创建默认社区健康文件”。

Issue 模板

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

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

Issue 模板在您希望在允许贡献者指定其 Issue 内容的同时提供打开 Issue 的指南时很有用。如果您希望贡献者在打开 Issue 时提供特定的结构化信息,Issue 表单有助于确保您收到所需的信息。

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

使用 Issue 表单,您可以使用 GitHub 表单模式创建具有 Web 表单字段的模板。当贡献者使用 Issue 表单打开 Issue 时,表单输入将转换为标准的 Markdown Issue 评论。您可以指定不同的输入类型并将输入设置为必需,以帮助贡献者在您的仓库中打开可操作的 Issue。有关更多信息,请参阅“为您的仓库配置 Issue 模板”和“Issue 表单的语法”。

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

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

可以使用传统的 issue 模板工作流程手动创建单个 Markdown 问题模板,项目贡献者将在 issue 内容中自动看到模板的内容。但是,我们建议使用升级后的多个 issue 模板构建器或 issue 表单来创建 issue 模板。有关传统工作流程的更多信息,请参阅 "手动为您的仓库创建单个 issue 模板”。

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

拉取请求模板

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

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

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