脚手架练习

工程开发 社区

技能解读

scaffold-exercises 是给 ai-hero 教学仓库用的——它把「新课的目录骨架」自动化:建出能通过 pnpm ai-hero-cli internal lint 的 exercises/ 子树,再正常 git commit。重点是严格遵循命名 + 结构规则,让 lint 和 pnpm run exercise 工具链跑得动。

命名规范

  • Section:XX-section-name/ 在 exercises/ 下,例如 01-retrieval-skill-building
  • Exercise:XX.YY-exercise-name/ 在 section 下,例如 01.03-retrieval-with-bm25
  • 编号 XX 是 section、XX.YY 是 exercise;命名一律 dash-case 小写

Exercise 三种 variant

每个 exercise 至少要有:problem/(带 TODO 的学生工作区)、solution/(参考实现)、explainer/(概念性材料、无 TODO)。Stub 时默认建 explainer/,除非计划另说。每个 variant 子目录里的 readme.md 不能为空(最少得有一行标题)、不能有死链;带代码的还得有 >1 行的 main.ts,但 stub 阶段允许 readme-only。

工作流

① 解析计划,抽出 section/exercise/variant;② mkdir -p 建路径;③ 每个 variant 写一份最小 readme(标题 + 描述);④ 跑 pnpm ai-hero-cli internal lint 验;⑤ 按报错迭代直到通过。重命名 / 移位用 git mv 而非 mv,保住 history。

Lint 摘要

检查项包括:每个 exercise 有 problem/solution/explainer 之一;至少 problem/ / explainer/ / explainer.1/ 有一个;主 variant 的 readme.md 非空;禁止 .gitkeep 与 speaker-notes.md;readme 里不能有死链;readme 不能含 pnpm run exercise 命令;非 readme-only 的子文件夹必须有 main.ts。

适合谁

  • 在 ai-hero 课程仓库或同款结构的教学项目里加新 section / exercise
  • 一次拆几十条 exercise 大纲、需要快速建骨架并保证 lint 通过

不适合

  • 不是 ai-hero 体系:lint 规则不通用,本技能没用武之地
  • 单题快速试做:直接手建文件比走骨架更快

配套

review-mattpocock(同体系的双轴 review)、setup-matt-pocock-skills(一键安装 Matt Pocock 系列技能)。

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
工程开发
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
88 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@mattpocock · 未声明许可证
上下文用量评级
低消耗
接入复杂程度
即装即用
是否需要外部接口密钥
不需要
兼容的系统
未声明(默认跨平台)
运行环境要求
未检出明确要求
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
网络行为
仅限本地
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

输出预览 scaffold-exercises.preview
Section 05: Memory Skill Building
- 05.01 Introduction to Memory
- 05.02 Short-term Memory (explainer + problem + solution)
- 05.03 Long-term Memory

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。