Misc
搭建练习脚手架
创建包含章节、问题、解答和讲解材料的练习目录结构,并使其通过 lint 检查。
搭建练习脚手架
创建能够通过 lint 检查的练习目录结构,然后用 git commit 提交。
目录命名
- 章节(Sections):位于
exercises/内的XX-section-name/ - 练习(Exercises):位于某章节内的
XX.YY-exercise-name/ - 名称采用 dash-case(全小写,用连字符分隔)
练习变体
每个练习至少需要以下子文件夹中的一个:
problem/—— 带有 TODO 标记的学生工作区solution/—— 参考实现explainer/—— 概念性材料,不含 TODO
必需文件
每个子文件夹都需要一个 readme.md,该文件不能为空且不能包含失效链接。
工作流
- 解析计划 —— 提取章节名称、练习名称和变体类型
- 创建目录 —— 对每个路径执行
mkdir -p - 创建占位 readme —— 为每个变体文件夹创建一个带标题的
readme.md - 运行 lint —— 进行校验
- 修复所有错误 —— 反复迭代直到 lint 通过