每当你被要求进行修改时,都遵循:
- 首先,让它能工作。
- 然后,把它做对。
- 遵循实践规范
先让它能工作
懒惰协议
- 一项决策只在一个地方定义。
- 只交付能够解决问题的最小改动。
从基础出发思考
- 先确定正确的数据结构,再编写逻辑。
- 凡是能让后续每个阶段受益的事,都优先做。
- 如果并发写入会造成影响,就不要共享状态。
TDD
- 修改代码前,先写一个会失败的测试。
- 确认它是因预期的原因而失败。
- 只做能让测试通过的最小改动。
- 如果很难写出如实反映行为的测试,就不要写一个糟糕的测试。
从第一性原理重新设计
- 不要把新需求硬接到旧设计上。
- 先问:如果这个需求从一开始就存在,你会怎么设计?把它想透,再分步交付。
质疑前提
- 当两个基于同一前提的修复都未通过同一道质量门时,用一句话写下这个前提,并数清哪些参与方承受着这种不平衡。
- 移除这项分配。
- 做完这件事之前,不要开始下一次修复。
先做减法,再做加法
- 添加任何东西之前,先移除复杂性。
以结果为导向执行
- 以能够验证的最终状态为目标。
- 只要是计划内且能够撤销,中途暂时把东西改坏也可以接受。
先造工具
- 如果这项工作不能一眼看明白,就构建一个完成它的工具。
- 先手动完成一个单元,再让工具准确复现这个单元。
架构
建模领域
- 用一种能让非法状态无法出现的结构来表达领域。
- 维护一份领域术语表。
- 如果代码已经清晰,而且只局限在一处,就不要动它。
严守边界
- 在数据进入系统时检查它。
- 进入系统后,就信任它。
- 把业务逻辑放在纯函数中。
严守类型系统
- 让非法值根本无法写出来。
- 外部数据只在进入系统时解析一次。
- 不要压制编译器。
让操作具备幂等性
- 无论运行两次,还是运行到一半崩溃后重新运行,最终都得到相同状态。
共享状态先分离,再考虑串行化
- 如果各方不需要同一个可变对象,就各自使用一份。
- 如果确实需要,就只允许一个写入方,并通过结构强制保证这一点。
再把它做对
修复根因
- 复现问题。
- 修掉根因。
- 只会隐藏崩溃的防护措施不算修复。
把工作拆成可验证的单元
- 完成一个小单元并验证它。
- 然后再开始下一个。
测试行为,而不是实现
- 测试应当像真正的用户一样调用代码,并检查用户能够看到的结果。
- 如果所有函数都不返回任何东西,测试仍然能通过,那就删掉这个测试。
Crapper
- 使用 crapper 工具
- 通过拆分函数、补充测试或两者并用,让每个函数的 CRAP 分数降到 10 以下。
- 考虑是否值得精简 case 语句。
Dryer
- 使用 dryer 工具,消除评分达到 0.8 或以上的重复代码。
Mutator
- 使用 mutator 工具
- 为尚未覆盖的代码补上测试。
- 消灭存活的变异体。
- 删除死代码。
重构
- 锁定代码当前的行为。
- 修改结构。
- 证明行为没有改变。
实践规范
保留日志
- 记录你执行的每个操作及其原因。
- 完成后报告这份日志。
守住上下文窗口
- 保持主对话精简。
- 把大块内容放到别处,只保留摘要。
清理 Worktree
- 找出可以安全移除的内容,确认仍在使用的东西都不受影响,然后回收磁盘空间。
- 未提交的工作保留原状,等待明确决定。
提交并推送
- 经常提交,并按顺序拆成小提交。
- 每个提交都说明为什么要改、改了什么,以及你如何证明改动正确。
- 最后推送到主线分支。