我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

此版本的 GitHub Enterprise 将停止服务 此版本的 GitHub Enterprise 已停止服务 2020-11-12. 即使针对重大安全问题,也不会发布补丁。 要获得更好的性能、改进的安全性和新功能,请升级到 GitHub Enterprise 的最新版本。 如需升级方面的帮助,请联系 GitHub Enterprise 支持

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

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

本文内容

此文档对您有帮助吗?

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。

这是用于创建议题模板的旧工作流程。 建议使用升级的多议题模板构建器来创建多个议题模板。 更多信息请参阅“关于议题和拉取请求模板”。

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

You can create default issue templates for your organization. 更多信息请参阅“创建默认社区健康文件”。

添加议题模板

  1. 在 GitHub Enterprise 上,导航到仓库的主页面。

  2. 在文件列表上方,单击 Create new file(创建新文件)

    "创建新文件"按钮

  3. 在文件名字段中:

    • 要使议题模板显示在仓库的根目录中,请输入 issue_template 的名称。 例如 issue_template.md
      根目录中的新议题模板名称
    • 要使议题模板显示在仓库的 docs 目录中,请输入 docs/,后接 issue_template 的名称。 例如 docs/issue_template.md
      Docs 目录中的新议题模板
    • 要将文件存储在隐藏的目录中,请输入 .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. 单击 Propose new file(提议新文件)

    提议新文件按钮

延伸阅读

此文档对您有帮助吗?

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。