Skip to main content
We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.
GitHub AE is currently under limited release.

手动为仓库创建单一议题模板

将手动创建的议题模板添加到仓库后,项目贡献者会自动在议题正文中看到模板的内容。

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

可以在任何支持的文件夹中创建 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"

添加议题模板

  1. 在 your enterprise 上,导航到存储库的主页。 1. 在文件列表上方,使用“添加文件”下拉列表,在其中单击“创建新文件” 。 “添加文件”下拉列表中的“创建新文件”
  2. 在文件名字段中:
    • 要使问题模板显示在存储库的根目录中,请输入 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 子目录中。 有关详细信息,请参阅“关于使用查询参数自动处理问题和拉取请求”。 隐藏目录中新的多问题模板
  3. 在新文件的正文中,添加您的议题模板。 这可能包括:
    - YAML 前页
    - 预期行为和实际行为
    - 问题重现步骤
    - 项目、操作系统或硬件的版本等规范 1. 在页面底部,输入一条简短、有意义的提交消息,描述您对文件所作的更改。 您可以在提交消息中将提交归于多个作者。 有关详细信息,请参阅“[创建具有多个共同作者的提交](/articles/creating-a-commit-with-multiple-authors)”。
    
    更改的提交消息 1. 在提交消息字段下面,确定是要将提交添加到当前分支还是新分支。 如果当前分支是默认分支,则应选择为提交创建新分支,然后创建拉取请求。 有关详细信息,请参阅“创建新的拉取请求”。 提交分支选项 模板在合并到存储库的默认分支时可供协作者使用。
  4. 单击“提供新文件”。 “提供新文件”按钮

延伸阅读