Documentation
README
变更校验关卡
看清「改了什么、影响哪里、文档是否跟上」——是变更的体检,不是审查替代品。
何时使用
| 场景 | 跑 | 判据 |
|---|---|---|
| 提交前(任何代码改动) | ✅ | 默认门禁 |
| 重构完成 | ✅ | 评估辐射面 |
| 设计级改动 | ✅ | DESIGN.md 是否同步 |
| PR review | ✅ | 替代手工 diff 计数 |
| 跨模块大改 | ✅ | 看依赖图是否成环 |
| 紧急 hotfix | ⚠ | 跑,但允许文档同步延后到稳定后 |
三种模式
| 模式 | 时机 | 用途 |
|---|---|---|
working (默认) |
写代码过程中 | 自检,看「我现在的工作面有哪些待整理」 |
staged |
git add 后、commit 前 |
提交闸,看「这一 commit 的合理性」 |
committed |
commit 完成后 | review,看「上一段历史改了哪些范围」 |
警告判定
| 警告 | 触发 | 处置 |
|---|---|---|
| 代码 >50 行 而 DESIGN.md 未更新 | 设计层面变化未留痕 | 补 DESIGN.md「改了什么/为何」段 |
| 代码 >30 行 而无测试更新 | 测试覆盖滞后 | 补单测/集成测;或在 PR 注明「该路径已有 E2E 覆盖」 |
| 新增文件而 README.md 未更新 | 用户视角文档滞后 | 补模块入口说明 |
| 配置变更未记录 | 部署可能踩坑 | CHANGELOG / DESIGN 留迁移说明 |
| 删除文件 | 引用可能未清理 | 全仓 grep 文件名/导出符号 |
This is the opening of the README. Read the full README on GitHub.