再无下文:Kubernetes上众多TODO注释遭到遗忘

2020 年 2 月 27 日

再无下文:Kubernetes上众多TODO注释遭到遗忘

Kubernetes 是个体量可观的大项目。这里说的“大”,指的不单单是愿景野心,同时也体现在源代码量层面。截至本文撰写之时,该项目拥有超过 86000 条提交、2000 多位贡献者、2000 多个开放问题、1000 多个公开 PR 以及超过 61000 星。绝非虚言,大家打开项目的 GitHub 页面即可求证。


根据计算,目前 Kubernetes 项目的 go 源代码量超过 430 万行(总代码量已经超过 520 万行),“actual”行超过 300 万,注释行也已经达到 70 万以上。项目的总文件数为 16000 多个,其中包括 vendor/目录。


我们的工作是通过一套代码库显示项目中的 TODO 注释量,希望帮助开发人员借此执行各类基础性项目管理流程。


这一次,我们决定利用一款小型 TODO 查找器对 Kubernetes 源代码进行一番筛查,看看结果究竟如何。下面来看我们的发现。


我们针对 commit 9bf52c2 的源代码运行了 tickgit。该 CSV 输出结果随后会被导入至 SQLite 以运行其他后续查询。请注意,该工具仅从已检出的提交当中查找 TODO 注释;曾经添加,但随后被删除的 TODO 部分不会被计入在内。因此,我们得出的数字将仅反映查询时仍“活动”于代码库之内的 TODO 注释。


  • 总体情况(9bf52c2)共存在来自363位不同作者、1230个文件的2380条TODO

  • 其中460条TODO注释指向明确待办人,例如 // TODO (patrickdevivo) Fix the …

  • 截至目前,2019年年内新增TODO数量为489条

  • 单一TODO的平均存在周期为860天(折合2.3年)

  • 最早的现存TODO创建于2014年6月6日 来自首次提交

  • 最新的TODO来自2019年12月9日

  • 单一文件中的最高TODO数量为33条

  • deads2k提交的现存TODO(git blame)量最高,为147条

  • 此次提交一次性添加了最多TODO(仍在源中),为64条


结果汇总计数文件路径
33cluster/gce/util.sh
25pkg/apis/core/types.go
23staging/src/k8s.io/api/core/v1/types.go
21staging/src/k8s.io/legacy-cloud-providers/aws/aws.go
20staging/src/k8s.io/code-generator/cmd/conversion-gen/generators/conversion.go
20pkg/apis/core/validation/validation.go
16test/e2e/network/service.go
16pkg/kubelet/kubelet.go
14test/e2e/framework/util.go
14pkg/kubelet/kubelet_pods.go


包含 TODO 最多的文件


作者计数
deads2k147
Clayton Coleman105
Chao Xu99
Dr. Stefan Schimanski93
Jordan Liggitt81
David Eads60
Random-Liu54
Wojciech Tyczynski50
Yu-Ju Hong43
Prashanth Balasubramanian38


提交 TODO 最多的作者


计数sha
646a4d5cd7cc58e28c20ca133dab7b0e9e56192fe3
19e01ff1641c7321ac81fe5775f6ccb21aa6775c04
194fb28dafad121e163fa86dc90067ce3d14415811
18adb75e1fd17b11e6a0256a4984ef9b18957d94ce
14963c85e1c807efcdbb82dd44439dc3c55f6a0bfd
148b17db7e0c4431cd5fd9a5d9a3ab11b04e2f0a7e
13f0f78299348afcf770d4e8d89dcea82f80811b28
11d0b94538b9744d0c06df6ddec2604be168568f9d
10f1248b9c829e225138ab6d6234221c63092f7592
10cd663d7ad00937cffa8a09e4761acb95d34c89a3


添加 TODO 最多的提交


计数年份
342014
2492015
5232016
6502017
4352018
4892019


各年份新增 TODO 数量


大家可以使用 tickgit todos --csv-output 获取原始 TODO 数据,得出与我们相似的查询结果。以上汇总内容来自 SQLite。


结论与问题这些结果未经任何处理与预设,完全是对 Kubernetes 源代码当中 TODO 注释的即时整理。我们对 TODO 的主要来源也比较明确,其中大部分由 Kubernetes 项目的顶尖贡献者创建。


我们还发现,虽然 Kubernetes 这种大规模项目的体量可观,但开发人员在 TODO 注释方面的行为模式与小项目没什么区别,只是绝对数量更高。


一大重要发现是,与 GitHub 提问相比,TODO 注释的数量更多。这是种有趣的现象,因为 TODO 代表着大量潜在的“工作内容”或者待办事项,而且除非我们亲身参与源代码开发,否则 TODO 对普通用户的提示性并不强。


核心贡献者们可能非常熟悉自己负责的代码库部分,也对自己的 TODO 与“潜在工作”了然于胸。但是,这一切在外部观察者看来毫无透明性可言。相比之下,GitHub 提问或者其他公开的交互跟踪机制显然更为便捷易用。


很多开发者朋友应该都清楚,软件项目本身类似于“生命体”。它会不时变化、持续改进、不断完善,同时带来大量讨论。工作流与流程安排非常重要,因为只有不断反思才能成就高质量的代码。通过在 Kubernetes 源代码当中的 TODO 注释,我们得以一窥反思的力量。然而,由于缺少相关基准,TODO 注释的平均存在周期长达 2.3 年,相当夸张。不过这里我们不敢评价太多,毕竟只有真正熟知项目内情的核心贡献者,才能断言 2.3 年算不算太长。接下来如果有机会,我们打算将 Kubernetes 的 TODO 周期与其他大型开源项目进行一番比较,相信结果会更有启发意义。


如果要对代码库中的 TODO 注释进行更深入的分析,我们可能需要纵观项目发展历程中曾经出现的所有 TODO,而不仅仅是仍存在于当前源代码中的 TODO。


  • TODO的平均关闭周期是多长?

  • TODO注释的平均生命周期是多长?

  • 不同流行代码库之间的TODO注释有何区别?


这事……有意义吗?当然有意义。TODO 注释所涉及的工作类型往往是那种不值得单独发一条申请,但却又比较重要的内容,因此有必要在代码行内做出注释与描述(当然,很多 TODO 也会引用问题/申请)。由于属于代码的组成部分,因为 TODO 与待完成工作往往“更加接近”。TODO 易于添加,但也很容易被遗忘(目前,Kubernetes 源代码当中仍然包含 1800 多条 2019 年之前添加的 TODO)。


我们希望能够创建一款显示相关代码元数据的工具,确保软件开发人员能够更轻松地完成规模不同、类型各异的项目,而显示 TODO 信息只是其中的一部分——当然,也是非常重要的一部分。


原文链接


https://medium.com/@augmentable/looking-at-kubernetes-2k-todo-comments-b2db42dc7fdb


2020 年 2 月 27 日 12:291260

评论

发布
暂无评论
发现更多内容

Week09作业

熊威

Flag: 给自己定个小目标

Fen9Pi

个人感悟

Gitlab 部署配置

wong

gitlab

影调:光影交响曲

北风

摄影 风光 影调 光影 人像

如果不懂编程,请看这里!!!

代码制造者

编程 低代码 零代码 编程学习

英特尔十代酷睿携手机械革命X3-S 纵享顺畅游戏之巅

飞天鱼2017

.net core快速开发平台,learun自主工作流引擎设计规范

力软.net/java开发平台

直播平台在贝壳找房中的实践与运用

陈威威

架构 分层架构 直播 分层思维 多元场景应用

女博士年薪156万入职华为!网友:实力演绎美貌与智慧并存

程序员生活志

华为 少年天才

微服务架构下的核心话题 (二):微服务架构的设计原则和核心话题

xcbeyond

架构 微服务 设计原则

计算之美(1/12)

我的偶像是木子

数据结构 算法

什么是深度强化学习?

华章IT

深度学习 强化学习 深度强化学习 智能体

信创舆情一线--工信部开展网络安全技术应用试点示范工作

统小信uos

环信大学:模型的边界!

环信

零基础建网站必备技能,看这一篇就够了

北柯

程序语言 网站搭建 编程网站

架构师训练营第九周

WW

打造高转化率网站不得不遵循的3条规范

姜奋斗

网站架构 网站 网站搭建 高转化率 转化

当百度遇上新基建:开放是基本原则 做智能时代的赋能者

百度大脑

人工智能 百度 AI 新基建 百度大脑

对于容器技术的看法

倾心煎蛋

详解GaussDB(for MySQL)服务:复制策略与可用性分析

华为云开发者社区

数据 路径 可用性 华为云 GaussDB

华为云的研究成果又双叒叕被MICCAI收录了!

华为云开发者社区

机器学习 AI 计算机视觉 医疗 华为云

原创 | 使用JPA实现DDD持久化- O:对象的世界(2/3)

编程道与术

Java hibernate DDD JDBC jpa

日入斗金,稳赚不赔?小心泛滥网络的兼职刷单让你钱尽财空

360安全卫士

【DevOps】Jenkins持续集成流水线(中)

Man

DevOps jenkins CI/CD JACOCO FINDBUG

第九周作业

Geek_a327d3

为Z3 Air-赋能,十代酷睿引领游戏5GHz新时代!

飞天鱼2017

中国四大银行正在大规模内测数字货币APP|可凭手机号完成转账

CECBC区块链专委会

数字货币 DCEP 中国人民银行

NIO的组成有哪些——奈学

古月木易

nio

NIO的组成有哪些——奈学

奈学教育

nio

百度大脑人脸离线识别SDK升级盘点,Linux ARM版本上线

百度大脑

人工智能 人脸识别 百度大脑 sdk

EasyDL的数据集、模型与代码的版本管理:灵活管理效率提升

百度大脑

人工智能 模型训练 百度大脑

再无下文:Kubernetes上众多TODO注释遭到遗忘-InfoQ