You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

自定义GitHub新建Issue页面模板是否需要配置config.yml文件?

GitHub Issue模板分类展示实现说明

你不需要必须使用config.yml文件就能实现带分类的新建Issue页面,你对官方文档的理解存在部分偏差。

核心原理

GitHub内置了两套Issue模板识别逻辑:

  • 基础识别逻辑:只要你在.github/ISSUE_TEMPLATE目录下存放多个带YAML前置元数据的.md格式模板文件,GitHub会自动将这些文件解析为独立的分类模板,直接展示在新建Issue选择页面。你提到的pylance仓库就是采用的该方案,其目录下的每个模板文件头部都配置了模板名称、描述、默认标签等元信息,因此不需要额外的config.yml也能正常展示分类。
  • 增强配置逻辑:config.yml属于增强配置文件,仅在你需要自定义如下能力时才需要添加:
    • 隐藏默认的空白Issue新建入口
    • 在模板选择页面顶部添加自定义提示文案
    • 调整模板展示排序
    • 配置YAML格式的Issue表单模板

实现步骤

你可以按如下操作快速实现分类模板效果:

  • 在仓库根目录创建.github/ISSUE_TEMPLATE文件夹
  • 为每个分类的Issue单独创建.md文件,比如bug_report.md、feature_request.md等
  • 在每个.md文件的最开头添加如下格式的YAML元数据,示例如下:
---
name: Bug反馈
about: 提交程序运行异常、不符合预期的问题
labels: bug
---
<!-- 下面是模板正文,按需填写引导用户提交信息的内容 -->
### 预期行为
<!-- 填写你预期的正确运行结果 -->

### 实际行为
<!-- 填写实际发生的异常情况 -->

### 复现步骤
1. 
2. 
3. 
  • 将上述文件提交推送到仓库的默认分支,刷新新建Issue页面即可看到分类模板选项。

内容的提问来源于stack exchange,提问作者JJJohn

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.09.29 16:36:01