用途
Scaffold Exercises 用于创建练习目录结构,使其通过 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
- 名称使用短横线命名(小写、连字符)
练习变体
一个练习可以包含以下一个或多个变体子文件夹:
- problem/ - 带有 TODO 的学生工作区
- solution/ - 参考实现
- explainer/ - 概念材料,无 TODO
在打桩(stubbing)时,默认使用 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 是权威的。其相关检查包括:
- 每个练习使用上述列表中的变体文件夹;不要求全部三个
- problem/、explainer/ 或 explainer.1/ 中至少存在一个
- 主文件夹中 readme.md 存在且非空
- 没有 .gitkeep 文件
- 没有 speaker-notes.md 文件
- readme 中没有失效链接
- readme 中没有 pnpm run exercise 命令
- 每个子文件夹需要 main.ts,除非仅含 readme
- 仅含 solution 的练习在创建前需要 linter 证明或聚焦的 fixture;否则遵循文档化的最小变体
移动/重命名练习
在重新编号或移动练习时:
- 使用 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"
适用场景
- 需要批量创建练习目录结构时
- 需要确保练习目录符合 lint 规则时
- 需要从计划快速生成练习脚手架时
限制
- 依赖 pnpm ai-hero-cli internal lint 命令
- 需要遵循特定的目录命名和文件要求
- 仅含 solution 的练习需要额外证明或 fixture
- 关于收费、价格、平台等信息暂未提供