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

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

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

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

您可以在任何支持的文件夹中创建 ISSUE_TEMPLATE/ 子目录,以包含多个议题模板,并且使用 template 查询参数指定填充议题正文的模板。 更多信息请参阅“关于使用查询参数自动化议题和拉取请求”。

要包含在社区资料检查列表中,议题模板必须位于 .github/ISSUE_TEMPLATE 文件夹中,并且包含有效的 name:about: YAML 前页。

您可以为组织创建默认议题模板。更多信息请参阅“为组织创建默认社区健康文件”。

添加议题模板

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

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

    “新建文件”按钮

  3. 在文件名字段中:

    • 要使议题模板显示在仓库的根目录中,请输入 issue_template 的名称。 例如 issue_template.md
      根目录中的新议题模板名称
    • To make your issue template visible in the repository's docs directory, type docs/ followed by the name of your 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. 在新文件的正文中,添加您的议题模板。 这可能包括:

    • 预期行为和实际行为。
    • 重现问题的步骤。
    • 规格,如项目版本、操作系统或硬件。
  5. 也可选择使用 titlelabelsassignees,自动设置默认议题标题、为议题模板添加标签和受理人或 YAML 扉页。

    ---
    title: 'Bug report'
    labels: bug
    assignees: octocat
    ---

    注:如果是 YAML 保留的字符,必须用引号括住。 例如,要在标签名称中使用表情符号添加标签,例如 :bug: Bug,则必须加上引号,如 ":bug: Bug",因为 : 是保留的字符。

  6. 在页面底部,键入简短、有意义的提交消息,描述您对文件所做的更改。您可以在提交消息中将提交归因于多个作者。更多信息请参阅“创建多个合作作者的提交."

    关于更改的提交消息

  7. 在 commit message(提交消息)字段下方,决定要将提交添加到当前分支还是添加到新分支。如果当前分支为 master,则应选择为提交创建新分支,然后创建拉取请求

    提交分支选项 Templates are available to collaborators when they are merged into the repository's default branch.

  8. 单击 Propose new file(提议新文件)

    Propose new file(提议新文件)按钮

延伸阅读

问问别人

找不到要找的内容?

联系我们