脚手架练习
创建可通过 pnpm ai-hero-cli internal lint 的练习目录结构,然后使用 git commit 提交。
目录命名
- Sections:
exercises/内的XX-section-name/(例如01-retrieval-skill-building) - Exercises: 章节内的
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:
# Exercise Title
Description here
如果子文件夹包含代码,还需要一个 main.ts(超过 1 行)。但对于存根,仅包含 readme 的练习也可以。
工作流程
- 解析计划 - 提取章节名称、练习名称和变体类型
- 创建目录 - 对每个路径使用
mkdir -p - 创建存根 readme - 每个变体文件夹一个带标题的
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文件 - readme 中不得有损坏链接
- readme 中不得出现
pnpm run exercise命令 - 除非仅包含 readme,每个子文件夹都必须有
main.ts
移动/重命名练习
重新编号或移动练习时:
- 使用
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"