跳至主要内容

关于 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 前置 matter 标记。有关更多信息,请参阅“为您的代码库配置 Issue 模板”。

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

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

Issue 模板存储在代码库的默认分支中,位于隐藏的 .github/ISSUE_TEMPLATE 目录中。如果您在另一个分支中创建模板,则协作者将无法使用它。Issue 模板文件名不区分大小写,并且需要 .md 扩展名。使用 Issue 表单创建的 Issue 模板需要 .yml 扩展名。要显示为社区资料清单中的复选标记,Issue 模板必须位于 .github/ISSUE_TEMPLATE 文件夹中,并且在 YAML 前置 matter 中包含有效的 name:about: 键(对于在 .md 文件中定义的 Issue 模板)或有效的 name:description: 键(对于在 .yml 文件中定义的 Issue 表单)。

可以使用旧版 Issue 模板工作流手动创建单个 Markdown Issue 模板,项目贡献者将自动在 Issue 正文中看到模板的内容。但是,我们建议使用升级后的多个 Issue 模板构建器或 Issue 表单来创建 Issue 模板。有关旧版工作流的更多信息,请参阅“手动为您的代码库创建单个 Issue 模板”。

您可以创建安全策略以向用户提供有关报告项目安全漏洞的说明。有关更多信息,请参阅“向您的代码库添加安全策略”。

Pull Request 模板

当您向代码库添加 Pull Request 模板时,项目贡献者将自动在 Pull Request 正文中看到模板的内容。

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

有关更多信息,请参阅“为您的代码库创建 Pull Request 模板”。