Initial commit
This commit is contained in:
@@ -0,0 +1,77 @@
|
||||
name: "问题反馈:代码或文档问题"
|
||||
description: "报告教程中的代码错误、文档错误、链接失效等问题"
|
||||
labels: ["bug", "needs triage"]
|
||||
title: "[问题反馈] 简要概述问题"
|
||||
body:
|
||||
- type: checkboxes
|
||||
id: checklist
|
||||
attributes:
|
||||
label: 提交前检查
|
||||
description: 为了提升处理效率,请先确认以下事项
|
||||
options:
|
||||
- label: 我已在 Issues 中搜索,未找到相同问题
|
||||
required: true
|
||||
- label: 我已使用仓库最新版(或 `main` 分支)进行复现
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: issue_type
|
||||
attributes:
|
||||
label: 问题类型
|
||||
options:
|
||||
- 代码运行错误
|
||||
- 文档描述错误/不清晰
|
||||
- 链接失效/资源缺失
|
||||
- 依赖/环境问题
|
||||
- 其他
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: location
|
||||
attributes:
|
||||
label: 位置(章节/文件路径)
|
||||
description: 如 `docs/chapter4/11_hybrid_search.md` 或 `code/C8/main.py`
|
||||
placeholder: 请输入章节编号、文档路径或代码相对路径
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: 问题描述
|
||||
description: 请清晰说明问题表现与期望行为
|
||||
placeholder: 实际结果 vs 期望结果
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: reproduction
|
||||
attributes:
|
||||
label: 复现步骤
|
||||
description: 清晰的复现步骤有助于快速定位
|
||||
placeholder: |
|
||||
1. ...
|
||||
2. ...
|
||||
3. ...
|
||||
- type: textarea
|
||||
id: minimal_code
|
||||
attributes:
|
||||
label: 最小可复现代码/命令
|
||||
description: 请尽量提供最小复现片段,或给出命令行
|
||||
render: shell
|
||||
placeholder: |
|
||||
python code/C8/main.py --config ...
|
||||
- type: textarea
|
||||
id: env
|
||||
attributes:
|
||||
label: 环境信息
|
||||
description: 操作系统、Python/Node 版本、依赖版本等
|
||||
placeholder: |
|
||||
OS: Windows 11 22631
|
||||
Python: 3.10.x
|
||||
依赖: langchain==..., llama-index==...
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: 日志/报错信息与截图
|
||||
description: 可粘贴报错文本或上传截图
|
||||
render: bash
|
||||
|
||||
|
||||
@@ -0,0 +1,3 @@
|
||||
blank_issues_enabled: false
|
||||
|
||||
|
||||
@@ -0,0 +1,54 @@
|
||||
name: "需求建议:希望新增教程内容"
|
||||
description: "提出希望本仓库新增/扩展的教程主题或方向"
|
||||
labels: ["enhancement", "discussion"]
|
||||
title: "[需求建议] 简要概述主题/方向"
|
||||
body:
|
||||
- type: checkboxes
|
||||
id: checklist
|
||||
attributes:
|
||||
label: 提交前检查
|
||||
options:
|
||||
- label: 我已在 Issues 中搜索,未找到相同或高度相似的建议
|
||||
required: true
|
||||
- type: input
|
||||
id: topic
|
||||
attributes:
|
||||
label: 希望新增的教程主题/模块
|
||||
description: 尽量简洁、明确
|
||||
placeholder: 例如:Agentic RAG、企业级项目
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: context
|
||||
attributes:
|
||||
label: 背景与痛点
|
||||
description: 为什么需要这一模块?解决哪些实际问题?
|
||||
placeholder: 场景背景、业务需求、目前的缺口
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: scope
|
||||
attributes:
|
||||
label: 建议覆盖的内容范围
|
||||
description: 可按章节/功能点列出
|
||||
placeholder: |
|
||||
1. 主题概述与系统架构
|
||||
2. 环境与数据准备
|
||||
3. 检索/索引/生成一体化示例
|
||||
4. 评估与监控
|
||||
- type: textarea
|
||||
id: audience
|
||||
attributes:
|
||||
label: 目标读者与预期效果
|
||||
description: 面向人群与学完后能做什么
|
||||
placeholder: 面向初学/进阶/生产落地;预期掌握的能力
|
||||
- type: textarea
|
||||
id: references
|
||||
attributes:
|
||||
label: 相关资料/链接(选填)
|
||||
description: 参考项目、论文、博客、Demo 等
|
||||
placeholder: |
|
||||
- 论文/项目链接:...
|
||||
- 竞品或类似教程:...
|
||||
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
name: "学习反馈:学习体验与改进建议"
|
||||
description: "分享你的学习体验、遇到的困惑,以及对教程改进的建议"
|
||||
labels: ["feedback"]
|
||||
title: "[学习反馈] 简要概述你的体验"
|
||||
body:
|
||||
- type: dropdown
|
||||
id: experience
|
||||
attributes:
|
||||
label: 整体学习体验
|
||||
options:
|
||||
- 非常好
|
||||
- 较好
|
||||
- 一般
|
||||
- 需要改进
|
||||
- 较差
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: what_helped
|
||||
attributes:
|
||||
label: 觉得教程哪些部分做得比较好?
|
||||
placeholder: 例如:章节结构清晰、代码可运行、图示易懂...
|
||||
- type: textarea
|
||||
id: what_confusing
|
||||
attributes:
|
||||
label: 学习过程中遇到的困惑/不足
|
||||
description: 请指出具体章节或文件,便于改进
|
||||
placeholder: 例如:`docs/chapter3/06_vector_embedding.md` 的某段描述不清晰
|
||||
- type: textarea
|
||||
id: improvement
|
||||
attributes:
|
||||
label: 你希望如何改进?
|
||||
placeholder: 举例说明更好的呈现方式、补充案例、增加背景知识等
|
||||
- type: input
|
||||
id: time_cost
|
||||
attributes:
|
||||
label: 学习用时(选填)
|
||||
placeholder: 例如:总计约 6 小时
|
||||
- type: textarea
|
||||
id: other
|
||||
attributes:
|
||||
label: 其他想说的话(选填)
|
||||
placeholder: 欢迎分享你的收获或对作者的建议
|
||||
|
||||
|
||||
Reference in New Issue
Block a user