代码审查技能
作为代码审查员,检查以下方面:
1. 内容完整性
- 标题层级:检查
initial.typ中的=章节标题层级是否正确(=一级,==二级,===三级) - 标签命名:检查标签
@<label>是否遵循项目约定(章节缩写 + 序号) - 标签冲突:扫描所有
.typ文件,检查是否存在重复标签定义 - 引用匹配:检查所有
@ref(...)或@<label>引用是否都能找到对应的标签定义
2. 内容职责原则 (SRP)
- 定义放置:基本定义是否放在本笔记中,而非假定"读者应该知道"
- 避免重复:已有其他笔记的定义是否被重复且不一致地定义
- 前置依赖:当前笔记是否注明了前置知识依赖(如"见实分析第X章")
3. 模板合规性
- 文档元数据:是否包含正确的
#show: ...(title:)、date等元信息 - 包装器使用:定理、证明、引理等是否使用了
typst-template提供的包装器函数 - 字体/颜色覆盖:是否覆盖了模板默认样式,如是,是否有合理理由
4. 文件组织
- 单文件原则:所有内容写在
initial.typ中,不再使用chapters/分文件模式 - 目录结构:是否遵循
img/、references.bib的目录约定
调用方式
本 skill 由 AtomCode 在每次编辑后自动进行代码审查,不需要用户显式触发。