跳至主要内容

手动为你的存储库创建单个问题模板

当你将手动创建的问题模板添加到你的存储库时,项目贡献者将自动在问题正文中看到模板的内容。

这是创建问题模板的旧工作流。我们建议使用升级后的多个问题模板生成器或问题表单来创建问题模板。有关详细信息,请参阅“关于问题和请求请求模板”。

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

您可以向每个问题模板添加 YAML 前置内容,以预先填充问题标题、自动添加标签和指派者,并为模板提供一个名称和说明,这些名称和说明将在人们在您的存储库中创建新问题时看到的模板选择器中显示。

以下是 YAML 前置内容示例。

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

注意:如果前置内容值包含 YAML 保留字符(如 :),则必须将整个值放入引号中。例如,":bug: Bug"":new: triage needed, :bug: bug"

要显示为 社区个人资料清单中的复选标记,问题模板必须位于 .github/ISSUE_TEMPLATE 文件夹中,并在 YAML 前置内容中包含有效的 name:about: 键(对于在 .md 文件中定义的问题模板)或有效的 name:description: 键(对于在 .yml 文件中定义的问题表单)。

您可以为您的组织或个人帐户创建默认问题模板和问题模板的默认配置文件。有关详细信息,请参阅“创建默认社区健康文件”。

添加问题模板

  1. 在 GitHub.com 上,导航到存储库的主页。

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

    或者,您可以在左侧的文件树视图中单击

    Screenshot of the main page of a repository. Above the list of files, a button, labeled "Add file," is outlined in dark orange. In the file tree view of the repository, a button with a plus sign icon is also outlined in dark orange.

  3. 在文件名字段

    • 要使您的问题模板在存储库的根目录中可见,请键入您的 issue_template 的名称。例如,issue_template.md
    • 要使您的问题模板在存储库的 docs 目录中可见,请键入 docs/ 后跟您的 issue_template 的名称。例如,docs/issue_template.md
    • 要将您的文件存储在隐藏目录中,请键入 .github/ 后跟您的 issue_template 的名称。例如,.github/issue_template.md
    • 要创建多个问题模板并使用 template 查询参数指定一个模板来填充问题正文,请键入 .github/ISSUE_TEMPLATE/,然后键入问题模板的名称。例如,.github/ISSUE_TEMPLATE/issue_template.md。您还可以在根目录或 docs/ 目录中的 ISSUE_TEMPLATE 子目录中存储多个问题模板。有关更多信息,请参阅“创建问题”。
  4. 在新文件的正文中,添加问题模板。这可能包括

    • YAML 前置内容
    • 预期行为和实际行为
    • 重现问题的步骤
    • 规范,例如项目版本、操作系统或硬件
  5. 单击提交更改...

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

  7. 在提交消息字段下方,决定是将提交添加到当前分支还是添加到新分支。如果当前分支是默认分支,则应选择为提交创建一个新分支,然后创建一个拉取请求。有关更多信息,请参阅“创建拉取请求”。

    Screenshot of a GitHub pull request showing a radio button to commit directly to the main branch or to create a new branch. New branch is selected.
    当模板合并到存储库的默认分支时,协作者可以使用这些模板。

  8. 单击提交更改建议更改

延伸阅读