给忙碌者的每日团队代码回顾建议 v0.3

本文欢迎转载。转载请注明“《给忙碌者的每日团队代码回顾建议》原文链接:https://www.jianshu.com/p/5f07bb5bc0e5”。

太长不读版

每日团队代码回顾的宗旨,是改变规则(即实践),而非个人。代码质量差,与其追究写代码的程序员的责任,不如建立团队的代码质量保证规则,并持续改善。我们无法改变一个人,让他更具有责任心,因为人只能靠自己去改变。但我们能相对容易地改变团队的规则,去影响人。规则比人更有确定性,且更容易改进。

未经删节版

本文假设

  • 团队的程序员都很忙

  • 团队线上事故频发

  • 团队有新人参与编写生产代码

每日团队代码回顾的定义

“团队代码回顾”,不是由一位有经验的程序员独自去评审另一位程序员的代码的“两人代码回顾”。

而是每天30分钟的团队针对当天所写代码的改进:每天在规定的时间(最好在快下班前)和规定的地点,团队所有程序员用30分钟左右,回顾当天所写的代码,找出其中的改进点,并将改进在下一次代码回顾前落地[1]

  • 为什么要做团队代码回顾,而不是“两人代码回顾”?

全局观:对于业务复杂的代码逻辑,多位熟悉各自业务领域的程序员在一起看,才能发现其中隐藏的代码缺陷[2]

反脆弱:将知识在团队内传播开,避免团队内唯一懂某一模块的程序员休假,而让团队掉链子

培养新人

  • 为什么要每日做?

“10行代码 == 10个问题”,
“500行代码” == “看起来不错”,
你还想每周只做1次团队代码回顾吗?

  • 为什么每天要在规定的时间和规定的地点做?

实践证明,对于刚刚实践代码回顾的团队,如果不进行“双规”,那么代码回顾的时间,会被各种突发情况所占用,导致最终没有时间进行代码回顾。

  • 在程序员尚未达到全栈水平时,是否需要分别进行前、后端的代码回顾[3]

可以分别进行,但建议不要同时进行,因为这样可以为愿意成为全栈的程序员提供分别参加两次代码回顾的便利。

  • 为什么code review不叫“代码评审”,而叫“代码回顾”?

因为要让“代码回顾”这个名字更尊重人。

要用能给人带来正面感受的词汇指代“代码回顾”:
代码回顾
代码展示
代码改进
代码改善
代码分享
代码复盘[4]

而不要使用给人带来负面感受的词汇:
代码走查
代码评审
代码检视[5]
代码审查
代码检查

每日团队代码回顾对团队的价值

能减少线上事故的几率,让团队业务经理能获得更多业绩,并减少通报批评的几率。

能减少计划外的返工时间,让程序员能获得更多的睡眠时间。

修复因忽视团队代码回顾而导致的线上事故,会大大增加计划外工作时间。

程序员的迭代估算,一般不会包括花在修复线上事故的时间。

计划外的返工修复线上事故的时间,只能压榨程序员已经少得可怜的睡眠时间,和思考“重要但不紧急”的事情的时间。

每日团队代码回顾的宗旨[6]

改变规则(即实践),而非个人。

代码质量差,与其追究写代码的程序员的责任,不如建立团队的代码质量保证规则,并持续改善。

我们无法改变一个人,让他更具有责任心,因为人只能靠自己去改变。

但我们能相对容易地改变团队的规则,去影响人。

规则比人更有确定性,且更容易改进。

给忙碌者的每日团队代码回顾建议

对于“太忙没时间”的团队

如果团队忙到每天挤不出30分钟一起做代码回顾,其实就意味着团队认为代码回顾的优先级较低,而不是没有时间

部门技术领导可以选出两个团队做试验,用数据说话[7]

选出两个团队,团队甲基本不做团队代码回顾,团队乙每日下班前做30分钟团队代码回顾。

搜集并对比两个团队的以下数据:整个团队(包括开发和测试人员)每个月花在计划外返工修复线上事故的时间总和。

让团队乙给团队甲分享每个月在代码回顾中所发现的代码缺陷,及所避免的计划外修复时间的估算。

对于有时间做每日团队代码回顾的团队

如果团队每天能在下班前30分钟一起做代码回顾,其实就表明团队认为代码回顾的优先级较高。

入门实践

  • 双规:团队每天要在规定的时间和规定的地点做代码回顾。

  • 团队通过讨论形成自己的代码规范标准,并通过每日团队代码回顾进行落地和改进[8]

  • 让团队所有程序员掌握基本的版本控制工具的技能[9]
  • 利用SonarQube等代码质量扫描工具,事先扫描要回顾的代码,并在代码回顾时展示扫描报告。

  • 最好在一个有大屏幕电视的会议室进行代码回顾[10]

  • 业务背景:由代码作者简要介绍回顾代码的业务背景[11]
  • 可读性:由非代码作者讲述代码变更的意图,看看代码是否具备高可读性。

  • 记录并分享:每天都有一位志愿者记录所发现的改进点(团队名称、日期、模块名、文件名、改进点、修复人、记录人、回顾人、参与人、修复状态),并上传团队wiki系统分享。

  • 每次回顾代码前,首先检查上次代码回顾所记录的改进点是否已经修复。

  • 统计:统计代码回顾的价值并随时通过wiki分享给团队。 可以统计每次团队代码回顾所能减少的线上事故个数,统计每次团队代码回顾所能减少的开发和测试人员的返工时间(估值)。

进阶实践

  • 拥有好用的代码对比工具,比如git和IntelliJ。

  • 代码回顾前要问3个问题:

    1. 回顾的代码是否来自团队主干分支?如果否,那么在把代码合并到团队主干分支后,再来做代码回顾。
    2. 回顾代码是否搞挂了团队主干分支的部署流水线?一旦搞挂流水线,要么在10分钟内修复,要么回退提交。
    3. 部署流水线上的用户旅程自动化回归单元测试是否运行成功?如果否,那么先回去把失败的自动化回归测试修复,再来做代码回顾。
  • 单意图提交:每位程序员确保每次代码提交都只包含一个意图[12],这样能避免“‘500行代码’ == ‘看起来不错’”的问题。另外,单意图提交的代码,在阅读、合并和撤回代码时,都会更加容易操作[13]

  • 频繁地合并代码:每位程序员每天至少合并一次代码到团队主分支。这样小批量发现的问题,能更容易解决;能避免“代码合并地狱”;有助于进行代码重构。

  • 清晰的代码提交注释:每位程序员确保每次代码提交都在提交注释里面写清修改意图,便于读代码。

高阶实践

  • 团队具备把大故事拆成小故事的技能[14]

总结

每日团队代码回顾,能让团队用更全面的视角,发现更多的代码缺陷,并且通过每天小批量地修复,让问题更容易解决。

从而让团队业务经理能获得更多绩效,减少线上事故通报的几率。

并能减少程序员的计划外返工时间,从而获得更多睡眠时间。

每日团队代码回顾的宗旨,是改变规则,而非个人。

对于“太忙没时间”的团队,可以尝试做试验用数据说话的方法,提高每日团队代码回顾的优先级。

而对于能实践每日团队代码回顾的团队,可以逐步采取入门、进阶和高阶实践。


  1. 感谢朋友廖源源子哥的反馈。

  2. 感谢网友Vernon的反馈。

  3. 感谢朋友廖源源子哥的反馈。

  4. 感谢网友张亮的反馈。

  5. 感谢乔梁乔帮主的反馈。

  6. 感谢朋友刘晓光的反馈。

  7. 感谢同事梅雪松梅老板的反馈。

  8. 感谢有赞科技杨勇的反馈。

  9. 感谢同事王晓峰的反馈。

  10. 感谢同事封小武的反馈。

  11. 感谢同事封小武的反馈。

  12. 感谢同事王晓峰的反馈。

  13. 感谢网友Vernon的反馈。

  14. 感谢同事王晓峰的反馈。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,919评论 6 502
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,567评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,316评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,294评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,318评论 6 390
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,245评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,120评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,964评论 0 275
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,376评论 1 313
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,592评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,764评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,460评论 5 344
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,070评论 3 327
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,697评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,846评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,819评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,665评论 2 354

推荐阅读更多精彩内容