【AICon】探索RAG 技术在实际应用中遇到的挑战及应对策略!AICon精华内容已上线73%>>> 了解详情
写点什么

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

  • 2020-02-27
  • 本文字数:2338 字

    阅读完需:约 8 分钟

再无下文: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-02-27 12:291975

评论

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

数据驱动创新,应用场景广泛

百度开发者中心

人工智能 数据分析 生成式AI 千帆大模型平台

软件定义汽车时代,1 亿行代码的安全保障,极狐GitLab 这么做!

极狐GitLab

gitlab 安全 DevSecOps 汽车 安全左移

基于Java开发的neo4j知识图谱、elasticsearch全文检索的数字知识库

金陵老街

OmniFocus 3 for Mac(GTD时间管理工具) v3.15中文激活版

mac

任务管理软件 苹果mac Windows软件 OmniFocus Standard

GitHub上标星23K+的Redis进阶笔记(应用+原理+集群+拓展+源码)

小小怪下士

Java redis 程序员 java面试

ELT in ByteHouse 实践与展望

字节跳动数据平台

数据库 大数据 云原生 数仓 企业号9月PK榜

百度APP iOS端包体积50M优化实践(六)无用方法清理

百度Geek说

ios 百度app 企业号9月PK榜

HarmonyOS创作激励计划启动:助力技术创作突破边界

HarmonyOS开发者

HarmonyOS

慢SQL原因分析之索引失效 | 京东物流技术团队

京东科技开发者

MySQL 数据库 sql 索引失效 企业号9月PK榜

美国2009年开始入侵华为总部服务器;马斯克脑机公司将进行首次人体试验;全球首个5G卫星电话拨通丨RTE开发者日报 Vol.54

声网

什么是模型混合模式?

3D建模设计

3D模型 gltf编辑器

区块链系统开发应用解决方案|去中心化应用dapp模式搭建

V\TG【ch3nguang】

开源框架中的责任链模式实践

vivo互联网技术

dubbo 设计模式 sentinel 责任链

企业微信针对百万级组织架构的客户端性能优化实践

JackJiang

网络编程 即时通讯 IM

人工智能在云计算中能发挥什么作用?

Finovy Cloud

GLTF编辑器:在线模型材质编辑工具

3D建模设计

纹理处理 GLTF 材质修改

视频转码工具 Compressor激活中文最新版

mac大玩家j

Mac软件 视频处理工具 视频编辑软件 编辑视频

CocoaPods 在iOS开发中养活了这么多项目,它到底是个啥? | 京东云技术团队

京东科技开发者

ios CocoaPods 移动开发 企业号9月PK榜

新生产力范式,重塑工作效率

百度开发者中心

人工智能 ChatGPT 生成式AI

AITO问界全系迎规模最大范围OTA升级,重新定义“智能天花板”

Geek_2d6073

百度智能云千帆大模型平台 2.0 产品技术解析

Baidu AICLOUD

异构计算 百度百舸 千帆大模型平台

GLTF编辑器的另一个作用:格式转换

3D建模设计

格式转换 GLTF glb

PWA建快应用,小程序建超级App?

没有用户名丶

智能合约跟单系统开发,一键自动跟单平台模式搭建

V\TG【ch3nguang】

成功入选 2023 谷歌出海创业加速器,Tapdata 乘势远航

tapdata

数据采集 数据集成 Tapdata

传媒软件的未来变革与发展趋势

百度开发者中心

传媒 生成式AI 千帆大模型平台

Mac电脑版MarkDown写作推荐 iA Writer 激活中文最新版

胖墩儿不胖y

markdown Mac软件 Markdown 编辑器 写作软件

如何在不同服务器之间来进行安全又极速的大量数据同步?

镭速

再无下文:Kubernetes上众多TODO注释遭到遗忘_容器_Patrick DeVivo_InfoQ精选文章