搭建练习
创建通过 pnpm ai-hero-cli internal lint 的练习目录结构,然后使用 git commit 提交。
目录命名
- 章节:
exercises/内的XX-section-name/(例如,01-retrieval-skill-building) - 练习:章节内的
XX.YY-exercise-name/(例如,01.03-retrieval-with-bm25) - 章节编号 =
XX,练习编号 =XX.YY - 名称是 dash-case(小写,连字符)
练习变体
每个练习需要至少一个这些子文件夹:
problem/- 带有 TODO 的学生工作区solution/- 参考实现explainer/- 概念材料,没有 TODO
在搭建时,默认为 explainer/,除非计划另有指定。
必需文件
每个子文件夹(problem/、solution/、explainer/)需要一个 readme.md:
- 不为空(必须有真实内容,即使单行标题也可以)
- 没有损坏的链接
在搭建时,创建带有标题和描述的最小 readme:
# 练习标题
描述在这里
如果子文件夹有代码,它还需要一个 main.ts(>1 行)。但对于存根,仅 readme 的练习是可以的。
工作流程
- 解析计划 - 提取章节名称、练习名称和变体类型
- 创建目录 - 为每个路径
mkdir -p - 创建存根 readmes - 每个变体文件夹一个带有标题的
readme.md - 运行 lint -
pnpm ai-hero-cli internal lint验证 - 修复任何错误 - 迭代直到 lint 通过
Lint 规则摘要
linter(pnpm ai-hero-cli internal lint)检查:
- 每个练习有子文件夹(
problem/、solution/、explainer/) - 至少存在
problem/、explainer/或explainer.1/之一 - 主要子文件夹中的
readme.md存在且非空 - 没有
.gitkeep文件 - 没有
speaker-notes.md文件 - readmes 中没有损坏的链接
- readmes 中没有
pnpm run exercise命令 - 每个子文件夹需要
main.ts,除非它是仅 readme
移动/重命名练习
重新编号或移动练习时:
- 使用
git mv(不是mv)重命名目录 - 保留 git 历史 - 更新数字前缀以保持顺序
- 移动后重新运行 lint
示例:
git mv exercises/01-retrieval/01.03-embeddings exercises/01-retrieval/01.04-embeddings
示例:从计划搭建
给定如下计划:
Section 05: Memory Skill Building
- 05.01 Introduction to Memory
- 05.02 Short-term Memory (explainer + problem + solution)
- 05.03 Long-term Memory
创建:
mkdir -p exercises/05-memory-skill-building/05.01-introduction-to-memory/explainer
mkdir -p exercises/05-memory-skill-building/05.02-short-term-memory/{explainer,problem,solution}
mkdir -p exercises/05-memory-skill-building/05.03-long-term-memory/explainer
然后创建 readme 存根:
exercises/05-memory-skill-building/05.01-introduction-to-memory/explainer/readme.md -> "# Introduction to Memory"
exercises/05-memory-skill-building/05.02-short-term-memory/explainer/readme.md -> "# Short-term Memory"
exercises/05-memory-skill-building/05.02-short-term-memory/problem/readme.md -> "# Short-term Memory"
exercises/05-memory-skill-building/05.02-short-term-memory/solution/readme.md -> "# Short-term Memory"
exercises/05-memory-skill-building/05.03-long-term-memory/explainer/readme.md -> "# Long-term Memory"