Skip to main content

GitHub AE 目前处于受限版。

为仓库配置议题模板

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

创建议题模板

  1. 在 你的企业 上,导航到存储库的主页。

  2. 在存储库名称下,单击 “设置”。 如果看不到“设置”选项卡,请选择“”下拉菜单,然后单击“设置”********。

    存储库标头的屏幕截图,其中显示了选项卡。 “设置”选项卡以深橙色边框突出显示。

  3. 在“功能”部分的“问题”下,单击“设置模板” 。 可能需要启用“问题”并刷新页面,然后才能看到按钮。

  4. 使用“添加模板”下拉菜单,单击要创建的模板类型。

    展开的“添加模板”下拉菜单的屏幕截图,其中显示了标准“Bug 报告”和“功能请求”模板。 此外,还列出了“自定义模板”。

  5. 要在提交到存储库之前预览或编辑模板,请单击模板旁边的“预览和编辑”。

  6. 要编辑模板,请单击 ,然后在字段中键入以编辑其内容。

    问题模板预览的屏幕截图。 在模板名称的右侧,铅笔图标以深橙色轮廓显示。

  7. 要自动设置默认问题标题,将问题分配给对存储库具有读取权限的人,或将标签应用于从模板提出的问题,请使用“可选附加信息”下的字段。 还可使用 YAML frontmatter 格式中的 titlelabelsassignees 将这些详细信息添加到问题模板中。

  8. 完成编辑和预览模板后,请单击页面右上角的“提供更改”。

  9. 在“提交消息”字段中,键入描述更改的提交消息。

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

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

配置模板选择器

可以通过向 .github/ISSUE_TEMPLATE 文件夹添加 config.yml 文件来自定义用户在存储库中创建新问题时看到的问题模板选择器。

你可通过将 blank_issues_enabled 设置为 false 来鼓励贡献者使用问题模板。 如果将 blank_issues_enabled 设置为 true,则用户可以选择打开空白问题。

注意:如果使用旧工作流在 .github 文件夹中手动创建 issue_template.md 文件,并在“config.yml”文件中启用空白问题,则当用户选择打开空白问题时,将使用 issue_template.md 中的模板。 如果您禁用空白议题,将永远不会使用模板。

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

下面是“config.yml”文件的一个示例。

YAML
blank_issues_enabled: false
contact_links:
  - name: GitHub Community Support
    url: https://github.com/orgs/community/discussions
    about: Please ask and answer questions here.
  - name: GitHub Security Bug Bounty
    url: https://bounty.github.com/
    about: Please report security vulnerabilities here.

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

  1. 在 你的企业 上,导航到存储库的主页。

  2. 在文件列表上方,使用“添加文件”下拉列表,在其中单击“创建新文件” 。

  3. 在“文件名”字段中,键入 .github/ISSUE_TEMPLATE/config.yml

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

  5. 在“提交消息”字段中,输入简短、有意义的提交消息,以描述对文件的更改。 您可以在提交消息中将提交归于多个作者。 有关详细信息,请参阅“创建有多个作者的提交”。

  6. 在提交消息字段下面,确定是要将提交添加到当前分支还是新分支。 如果当前分支是默认分支,则应选择为提交创建新分支,然后创建拉取请求。 有关详细信息,请参阅“创建拉取请求”。

    GitHub 拉取请求的屏幕截图,其中显示了一个单选按钮,用于直接提交到主分支或创建新分支。 已选择“新建分支”。

  7. 单击“提交更改”或“建议更改” 。

延伸阅读