本页目录

本页目录

变更纪律

每项实质性变更交付评审前,都要按这份清单检查,并遵循操作协议。

完成清单

在认定一项变更完成之前:

  • 确认要求的行为确实已经实现。
  • 运行相关的格式检查。
  • 运行 Lint 检查。
  • 在适用时运行类型检查。
  • 运行相关测试。
  • 运行相应的 prek 检查。
  • 提交时,校验 Conventional Commits。
  • 检查 diff。
  • 检查是否有非预期变更。
  • 检查是否有不必要的新依赖。
  • 检查是否有不必要的新文件。
  • 检查架构兼容性。
  • 检查代码语言合规性(语言政策)。
  • 检查产品语言合规性(语言政策)。
  • 检查敏感信息(安全)。

示例:修复偶发失败的登录测试

待评审的变更:tests/e2e/login.spec.ts 在 CI 中间歇性失败;修复方案是将固定等待 3 秒改为等待 session cookie。

先确认行为。偶发失败的测试必须连续多次通过,不能只通过一次:

mise run test e2e/login.spec.ts   # 20 consecutive runs, 20/20 green

运行静态检查:

$ mise run check
oxfmt   ok
oxlint  ERROR tests/e2e/login.spec.ts:4:3  no-unused-vars  `expect` is never used
tsc     not reached

删除残留的 import 后再运行一次。通过时应如下所示:

$ mise run check
oxfmt   ok
oxlint  ok
tsc     ok

然后审阅 diff:

$ git diff --stat
 tests/e2e/login.spec.ts | 8 +++++---
 1 file changed

只改了一个文件:没有新增依赖或文件,也不影响架构。测试里新增的注释按语言政策使用英文;没有改动用户界面文案;测试凭据留在测试夹具中,未出现在 diff 里(安全)。

提交。prek 会对暂存区再次运行同样的检查,提交信息遵循 Conventional Commits:

$ git commit -m "test(e2e): wait for session cookie instead of fixed sleep"
prek  ok  format check, lint, secret scanning

提交前,所有检查必须通过,diff 必须逐行审阅,每处变更都必须能解释清楚。

CI 通过不是正确性的证明

CI 通过是必要条件,但它本身不能证明实现正确。

不要把流水线通过当作审阅 diff、判断变更是否正确的替代品。