github如何创建issue模板

以下是 GitHub 上新建 Issue 模板的详细步骤和配置方法，结合官方实践和社区经验整理而成：

---

🔧 一、创建模板目录结构

1. 新建隐藏文件夹

   • 在仓库根目录下创建 .github/ISSUE_TEMPLATE 文件夹：

     mkdir -p .github/ISSUE_TEMPLATE
     

   • 若需兼容 Gitee 等平台，可同时创建 .gitee/ISSUE_TEMPLATE 目录（优先级低于 .github）。

---

📝 二、选择模板格式（两种方案）

方案一：传统 Markdown 模板（.md 文件）

• 在 .github/ISSUE_TEMPLATE 内创建 .md 文件（如 bug_report.md）。

• 文件头部需包含 YAML 元数据块定义模板属性：

  ---
  name: 🐞 Bug 报告
  about: 用于提交代码缺陷
  title: "[BUG] "
  labels: bug, pending
  ---
  ## 重现步骤
  1\. ...
  2\. ...
  ## 预期行为
  ## 实际行为
  ## 截图或日志
  

方案二：结构化表单模板（推荐 · .yml 文件）

• 创建 .yml 文件（如 feature_request.yml）：

  name: ✨ 功能建议
  description: 提交新功能或优化建议
  title: "[Feature]: "
  labels: ["enhancement"]
  body:
    - type: textarea
      id: description
      attributes:
        label: 需求描述
        placeholder: 详细说明功能场景和价值
      validations:
        required: true
    - type: checkboxes
      attributes:
        label: 附加选项
        options:
          - label: "我愿参与此功能开发"
            required: false
  

• 字段类型说明：

  • input：单行文本（如标题）
  • textarea：多行文本（如日志）
  • dropdown：下拉菜单（如优先级）
  • checkboxes：多选框（如功能选项）
  • markdown：说明文本（不可编辑）。

---

⚙️ 三、高级配置（可选）

1. 模板选择器（config.yml）
   在 .github/ISSUE_TEMPLATE 下创建 config.yml 控制全局行为：

   blank_issues_enabled: false  # 禁用空白 Issue
   contact_links:
     - name: "📚 社区讨论"
       url: https://example.com/forum
       about: 提交前请先查阅社区共识
   

2. 自动化规则

   • labels：自动打标签（如 bug）
   • assignees：自动分配负责人（需是仓库成员）
   • validations: required: true：强制必填字段。

---

✅ 四、验证与生效

1. 提交文件到仓库
   将模板文件推送到仓库的默认分支（如 main 或 master）。
2. 用户侧效果：
   • 点击仓库的 Issues → New issue 时，显示模板选择界面。
   • 提交后自动应用预设标签和分配逻辑。

---

💡 最佳实践建议

1. 模板分类：为不同场景（Bug/功能/文档）创建独立模板，提升信息结构化。
2. 必填项精简：核心问题（如重现步骤）设为必填，非关键项设为可选。
3. 兼容性：若需跨平台（GitHub/Gitee），优先使用 .github/ISSUE_TEMPLATE 目录。

参考示例项目：GitHub 官方模板示例
通过此配置，可显著提升 Issue 提交质量，减少无效反馈，加速问题处理流程。