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

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

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

本文内容

This is the legacy workflow to create an issue template. We recommend using the upgraded multiple issue template builder to create multiple issue templates. 更多信息请参阅“关于议题和拉取请求模板”。

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

You can add YAML frontmatter to each issue template to pre-fill the issue title, automatically add labels and assignees, and give the template a name and description that will be shown in the template chooser that people see when creating a new issue in your repository.

Here is example YAML front matter.

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

Note: You must put YAML-reserved characters such as : in quotes. For example, ":bug: Bug".

To be included in the community profile checklist, issue templates must be located in the .github/ISSUE_TEMPLATE folder and contain valid name: and about: YAML front matter.

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

添加议题模板

  1. On GitHub, navigate to the main page of the repository.

  2. Above the file list, click Create new file.

    The New file button

  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. 在新文件的正文中,添加您的议题模板。 这可能包括:

    • YAML frontmatter
    • Expected behavior and actual behavior
    • Steps to reproduce the problem
    • Specifications like the version of the project, operating system, or hardware
  5. At the bottom of the page, type a short, meaningful commit message that describes the change you made to the file. You can attribute the commit to more than one author in the commit message. For more information, see "Creating a commit with multiple co-authors."

    有关更改的提交消息

  6. 在提交消息字段下面,确定是要将提交添加到当前分支还是新分支。 If your current branch is master, you should choose to create a new branch for your commit and then create a pull request. For more information, see "Creating a new pull request."

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

  7. Click Propose new file.

    Propose new file button

延伸阅读

问问别人

找不到要找的内容?

联系我们