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

为仓库配置议题模板

您可以自定义贡献者在仓库中打开新议题时可使用的模板。

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

本文内容

创建议题模板

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

  2. Under your repository name, click Settings.

    Repository settings button

  3. 在“Features(功能)”部分的“Issues(议题)”下,单击 Set up templates(设置模板)

    Start template setup button

  4. 使用 Add template(添加模板)下拉菜单,单击要创建的模板类型。

    添加模板下拉菜单

  5. 要在提交到仓库之前预览或编辑模板,请单击 Preview and edit(预览和编辑)

    预览和编辑按钮

  6. To edit the template, click , and type in the fields to edit their contents.

    Issue template edit button

  7. 要自动设置默认的议题标题、将议题分配给对仓库有读取权限的人或者对议题模板应用标签,请在“Optional additional information(可选附加信息)”下输入这些详细信息。还可以通过 YAML 前页格式中的 titlelabelsassignees 为议题模板添加这些详细信息。

    Additional info for issue template

  8. 完成编辑和预览模板后,请单击页面右上角的 Propose changes(提议更改)

    提议更改按钮

  9. 输入提交消息,描述您的更改。

    议题模板提交消息字段

  10. 在提交消息字段的下方,决定是直接将模板提交到默认分支,还是创建新分支并打开拉取请求。 有关拉取请求的更多信息,请参阅“关于拉取请求”。

    选择将议题模板提交到 master 或打开拉取请求

  11. 单击 Commit changes(提交更改)。 将这些更改合并到默认分支后,贡献者在仓库中打开新议题时便可使用该模板。

配置模板选择器

您可以通过添加一个 config.yml 文件到 .github/ISSUE_TEMPLATE 文件夹,来自定义在仓库中创建新议题时所看到的议题模板选择器。

您可以通过将 blank_issue_enabled 设置为 false,要求贡献者使用议题模板。 如果您将 blank_issue_enabled 设置为 true,人们将可选择打开空白议题。

注: 如果您使用旧工作流程手动创建一个 issue_template.md 文件并在您的 config.yml 文件中启用空白问题。人们选择打开空白议题时将使用 issue_template.md 中的模板。 如果您禁用空白议题,将永远不会使用模板。

如果您愿意在 GitHub 之外接收某些报告,您可以使用 contact_links 将用户引导到外部站点。

以下是 config.yml 文件的一个例子:

blank_issues_enabled: false
contact_links:
  - name: GitHub 社区论坛
    url: https://github.community/
    about: Please ask and answer questions here.
  - name: GitHub Security Bug Bounty
    url: https://bounty.github.com/
    about: Please report security vulnerabilities here.

当文件合并到仓库的默认分支时,您的配置文件将自定义模板选择器。

  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. 在文件名字段中,键入 .github/ISSUE_TEMPLATE/config.yml

    配置文件名

  4. 在新文件的正文中,键入配置文件的内容。

    配置文件内容

  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."

    提交分支选项

  7. Click Propose new file.

    Propose new file button

延伸阅读

问问别人

找不到要找的内容?

联系我们