手动为你的仓库创建单个 Issue 模板

你可以在任何受支持的文件夹中创建 ISSUE_TEMPLATE/ 子目录以包含多个 Issue 模板，并使用 template 查询参数指定将填充 Issue 正文的模板。有关更多信息，请参阅“创建 Issue”。

你可以向每个 Issue 模板添加 YAML 前置 matter，以预填充 Issue 标题，自动添加标签和指派者，并为模板提供名称和说明，这些名称和说明将在人们在你的仓库中创建新 Issue 时看到的模板选择器中显示。

这是一个 YAML 前置 matter 示例。

---
name: Tracking issue
about: Use this template for tracking new features.
title: "[DATE]: [FEATURE NAME]"
labels: tracking issue, needs triage
assignees: octocat
---

要在社区资料清单中显示复选标记，Issue 模板必须位于 .github/ISSUE_TEMPLATE 文件夹中，并在 YAML 前置 matter 中包含有效的 name: 和 about: 密钥（对于在 .md 文件中定义的 Issue 模板）或有效的 name: 和 description: 密钥（对于在 .yml 文件中定义的 Issue 表单）。

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

添加 Issue 模板

1. 在 GitHub 上，导航到仓库的主页。

2. 在文件列表上方，选择**添加文件**下拉菜单，然后点击 创建新文件.

   或者，你可以点击左侧的文件树视图中的。

   

3. 在文件名字段中

   • 要使你的 Issue 模板在仓库的根目录中可见，请键入你的 issue_template 的名称。例如，issue_template.md。
   • 要使你的 Issue 模板在仓库的 docs 目录中可见，请键入 docs/，后跟你的 issue_template 的名称。例如，docs/issue_template.md，
   • 要将你的文件存储在隐藏目录中，请键入 .github/，后跟你的 issue_template 的名称。例如，.github/issue_template.md。
   • 要创建多个 Issue 模板并使用 template 查询参数指定要填充 Issue 正文的模板，请键入 .github/ISSUE_TEMPLATE/，然后键入你的 Issue 模板的名称。例如，.github/ISSUE_TEMPLATE/issue_template.md。你还可以将多个 Issue 模板存储在根目录或 docs/ 目录中的 ISSUE_TEMPLATE 子目录中。有关更多信息，请参阅“创建 Issue”。

4. 在新文件的正文中，添加你的 Issue 模板。这可能包括

   • YAML 前置 matter
   • 预期行为和实际行为
   • 重现问题的步骤
   • 规范，例如项目的版本、操作系统或硬件

5. 点击**提交更改...**

6. 在“提交消息”字段中，键入一条简短且有意义的提交消息，描述你对文件所做的更改。你可以在提交消息中将提交归因于多个作者。有关更多信息，请参阅“使用多个作者创建提交”。

7. 在提交消息字段下方，决定是否将你的提交添加到当前分支或新分支。如果你的当前分支是默认分支，则应选择为你的提交创建新分支，然后创建 Pull Request。有关更多信息，请参阅“创建 Pull Request”。

   
   当模板合并到仓库的默认分支时，协作者可以使用这些模板。

8. 点击**提交更改**或**建议更改**。

进一步阅读

• "关于 Issue 和 Pull Request 模板"
• "为你的仓库配置 Issue 模板"
• "创建 Issue"