SHA256
Issue Templates
结构化的 Issue 模板, 引导学生在提问前思考、规范问题描述, 减少低质量和重复提问。
设计理念
每个模板都包含以下引导机制:
- 强制先思考再提问 - 每个模板都有"你目前的理解"或"已尝试的方法"必填字段, 促使学生先尝试自己解决
- 减少重复提问 - 提交确认中要求"已搜索过已有 Issue"
- 结构化信息收集 - 使用 YAML 表单格式(dropdown、textarea with render 等), 比自由文本更规范
- 禁止空白 Issue -
config.yaml设置blank_issues_enabled: false, 强制使用模板
目录结构
issue-templates/
├── general/ general 仓库使用
│ └── .gitea/ISSUE_TEMPLATE/
│ ├── config.yaml 禁止空白 Issue + 外部链接
│ ├── course-question.yaml 课程内容 / 知识点答疑
│ ├── homework-help.yaml 编程作业问题
│ └── env-setup.yaml 环境配置问题
└── homework/ hwXX 作业仓库使用
└── .gitea/ISSUE_TEMPLATE/
├── config.yaml 禁止空白 Issue + 引导到 general
└── homework-help.yaml 编程作业问题(无作业编号字段)
模板说明
general 仓库(3 个模板)
课程内容 / 知识点答疑 (course-question.yaml)
适用于 C/C++ 语法、数据结构、算法等课程内容的概念性疑问。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 问题分类 | dropdown | Y | 语法 / 数据类型 / 指针与内存 / 函数 / 结构体 / 文件操作 / 预处理 / 其他 |
| 问题描述 | textarea | Y | 清晰描述问题 |
| 你目前的理解 | textarea | Y | 描述当前理解和困惑点 |
| 参考资料 | textarea | N | 已查阅的教材/网络资源 |
| 提交确认 | checkboxes | Y | 已搜索重复 + 已查阅教材 |
编程作业问题 (homework-help.yaml)
适用于作业中遇到的编译错误、运行时错误、逻辑问题。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 作业编号 | input | Y | 如 "hw03 第2题" |
| 问题类型 | dropdown | Y | 编译错误 / 运行时错误 / 逻辑错误 / 思路不清晰 / 其他 |
| 问题描述 | textarea | Y | |
| 相关代码 | textarea (render: c) | Y | 代码片段, 自动语法高亮 |
| 错误信息 / 实际输出 | textarea (render: shell) | N | |
| 期望行为 | textarea | Y | |
| 已尝试的调试方法 | textarea | Y | 核心引导字段 |
| 提交确认 | checkboxes | Y | 已搜索重复 + 仅贴相关代码 |
环境配置问题 (env-setup.yaml)
适用于 IDE 安装、编译器配置、开发环境搭建问题。课程统一使用 Windows。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| IDE / 编辑器 | dropdown | Y | Visual Studio / VS Code / CLion / Dev-C++ / Code::Blocks / 其他 |
| 编译器 | dropdown | Y | MSVC / GCC (MinGW) / Clang / 不确定 / 其他 |
| 问题描述 | textarea | Y | |
| 已尝试的解决方法 | textarea | Y | 核心引导字段 |
| 错误截图 / 日志 | textarea | N | 支持拖拽上传图片 |
| 提交确认 | checkboxes | Y | 已搜索重复 + 已查阅配置指南 |
homework 仓库(1 个模板)
作业仓库仅包含 homework-help.yaml, 与 general 版本的区别:
- 无"作业编号"字段 - 仓库名(hw01, hw02...)本身即标识作业
- 新增"题目理解"问题类型 - dropdown 中增加此选项
- config.yaml 中引导非作业问题到 general 仓库
部署方式
模板通过 Python CLI 工具推送到仓库:
# 初始化时自动推送到 general 仓库
uv run tjhlp setup init --org tjhlp-2025f
# 创建作业仓库时自动推送作业模板
uv run tjhlp repos create-homework --org tjhlp-2025f --number 1
# 手动推送到指定仓库
uv run tjhlp repos init-templates tjhlp-2025f/general --type general
uv run tjhlp repos init-templates tjhlp-2025f/hw01 --type homework
自定义
如需调整模板内容(如添加新的问题分类、修改引导文案), 直接编辑对应的 YAML 文件, 然后重新推送:
uv run tjhlp repos init-templates tjhlp-2025f/general --type general
YAML 模板语法参考 Gitea 文档。