Files
happy-llm/.github/ISSUE_TEMPLATE/book_issue.md
KMnO4-zx b1d54ad3b9 docs(issue_template): 在问题模板中添加YAML前后分隔符
为书籍问题模板文件添加标准的YAML前后分隔符(---),以符合GitHub issue模板的规范格式
2025-06-04 22:07:20 +08:00

2.7 KiB
Raw Blame History

name, description, title, labels, body
name description title labels body
Happy-LLM 问题反馈 / Textbook Issue Report 报告 Happy-LLM 中的代码/内容问题 / Report code/content issues in textbook [问题/Issue] 章节X.X简短问题描述 / ChapterX.X: Brief description
bug
需要审核/needs-review
type attributes
markdown
value
🐛 **请提供以下信息帮助我们快速定位问题 / Please provide the following information to help us locate the issue**
type id attributes validations
input chapter
label description placeholder
1. 遇到问题的章节 / Affected Chapter 格式示例Chapter3.2 或 Chapter6.4 / Format example: Chapter3.2 or Chapter6.4 ChapterX.X
required
true
type id attributes validations
textarea problem
label description placeholder
2. 具体问题描述 / Problem Description 请清晰描述遇到的问题现象或错误信息 / Clearly describe the issue or error message - 代码问题:遇到了什么错误?预期行为是什么?/ Code issue: What error occurred? Expected behavior? - 内容问题:哪里不准确/有歧义?/ Content issue: What is inaccurate/ambiguous? 代码运行时出现XX错误 / E.g.: XX error when running code... 例图3-5的内容描述不准确 / E.g.: Inaccurate description in Figure 3-5...
required
true
type id attributes validations
textarea reproduction
label description placeholder
3. 问题重现材料 / Reproduction Materials 🔧 根据问题类型提供以下内容 / Provide based on issue type: - 代码问题:完整代码片段+错误日志 / Code issue: Full code snippet + error log - 内容问题:相关段落/图片编号+修改建议 / Content issue: Related paragraph/figure + suggested fix - 格式问题:截图+问题位置描述 / Format issue: Screenshot + location description ```python # 代码问题请粘贴完整代码 / Paste full code for code issues print("问题重现代码 / reproduction code") ``` **错误信息 / Error log**: ``` 粘贴完整的错误日志 / Paste full error log ``` **建议修改 / Suggested fix**: 对原内容的修改建议... / Your suggested modification...
required
true
type id attributes
checkboxes checks
label description options
确认事项 / Verification 请确认以下事项 / Please confirm the following
label required
此问题未在过往Issue中被报告过 / This issue hasn't been reported before true