关于java:80的程序员不会写commit记录

2次阅读

共计 2318 个字符，预计需要花费 6 分钟才能阅读完成。

据说，80% 的程序员，不会写 commit 记录。这个比例在无标准的小公司，比例会更高一些，能够看到这是一个如许广泛的问题。

程序员应该写出简洁明了的commit log，否则对他人和本人来说就是一种困扰。最近代码 review 多了，总有一股想笑的感觉。就像下图这满屏的 ok，永远无奈从中得悉提交人的用意。

开源一套以教学为目标零碎，欢送 star：github.com/xjjdog/bcma…。它蕴含 ToB 简单业务、互联网高并发业务、缓存利用；DDD、微服务领导。模型驱动、数据驱动。理解大型服务进化路线，编码技巧、学习 Linux，性能调优。Docker/k8s 助力、监控、日志收集、中间件学习。前端技术、后端实际等。次要技术：SpringBoot+JPA+Mybatis-plus+Antd+Vue3。

commit log 将如何提交？都有哪些约定？其实是有答案的。对于 Java 程序员，尤其幸福。IDEA 有一个十分好用的插件，能够用来辅助你进行代码提交，辅助你进行团队标准建设。接下来，我将带大家看一看它的应用办法。

在 IDEA 的 Marketplace 中，搜寻Git Commit Template，就能够装置这个插件。插件很小，很快就能下载下来。

失常从 IDEA 提交代码的时候。咱们发现多了一个小按钮。

点击之后，将弹出一个窗口。让你去设计提交模板。

这么多信息，真的让人头晕。怪不得程序员们都不喜爱写提交记录。

其实，在插件的装置界面，就曾经阐明了这个提交记录的格局。

 <type>(<scope>): <subject>
 <BLANK LINE>
 <body>
 <BLANK LINE>
 <footer>

从形容中，能够肯容易的看到一个提交记录中，应该蕴含哪些货色。其中类型最多的，当然是提交类型。

咱们依照插件显示的程序来阐明一下。

feat 性能 feature 的意思，也是最罕用的。当你的性能有变更的时候，都能够采纳这种类型的 type
fix 当然指的是 bug 修复
docs 更新了文档，或者更新了正文
style 代码格局调整，比方执行了 format、更改了 tab 显示等
refactor 重构代码。指的是代码构造的调整，比方应用了一些设计模式从新组织了代码
perf 对我的项目或者模块进行了性能优化。比方一些 jvm 的参数改变，把 stringbuffer 改为 stringbuilder 等
test 这个简略，就是减少了单元测试和自动化相干的代码
build 影响编译的一些更改，比方更改了 maven 插件、减少了 npm 的过程等
ci 继续集成方面的更改。当初有些 build 零碎喜爱把 ci 性能应用 yml 形容。如有这种更改，倡议应用 ci
chore 其余改变。比方一些正文批改或者文件清理。不影响 src 和 test 代码文件的，都能够放在这里
revert 回滚了一些后面的代码

除了这些预设的，团队还能够依照本人的需要，减少新的 type。比方专门解决线上工单，就能够发明一个叫做ticket 的类型。

scope 是范畴的意思，次要指的是代码的影响面。scope 并没有要求强制，但团队能够依照本人的了解进行设计。通常由技术维度和业务维度两种划分形式。比方依照技术分为：controller、dto、service、dao等。但因为一个性能提交，会波及到多个 scope（都不喜爱十分细粒度的提交），所以依照技术维度分的状况比拟少。

依照业务模块进行划分，也是比拟不错的抉择。比方分为 user、order 等划分，能够很容易看出是影响用户模块还是 order 模块。

如果你切实不晓得怎么填，那就留空。

这个体现的是总结概括能力，没得跑。一句话可能阐明次要的提交是什么。subject 也是泛滥 git 管理工具默认显示的一行。如果你写的规范，那么提交记录看起来就很漂亮很规整。

次要填写具体的改变记录。我个别习惯列上 1234，但如果你的 subject 写的十分好，注释能够间接弱化。但如果工夫富余，填写上重要记录的前因后果，需要背景，是一个好的习惯。

增加一些额定的 hook，比方提交记录之后，主动敞开 jira 的工单（JIRA 和 gitlab 等是能够联动的）。在比方触发一些文档编译或者其余动作。

这部分自定义行也是比拟强的。

最初还有一个 skip CI 选项。个别的 ci 工具，都能够设置提交代码时主动触发编译。但你能够通知它疏忽本次提交。这可能是因为你提前预判到了一些构建危险，或者就是不想编译。

最初，看一个典型的提交记录，有了工具的反对，咱们的瞎扯也看得正经起来。

fix(order): 修复了 1 分钱买汽车的 bug

商务反馈能够 1 分钱买汽车，目前曾经卖出了 100w 量

Closes #2455

[skip ci]

其实，提交的外围是 type 和subject。一个用来示意它的提交类型，一个用来对提交进行概括性总结，写好了这两点，就能轻轻松松秒杀 80% 的程序员了。

有了这些根底，从commit log，主动生成change log，就变的十分的容易。配合继续集成平台，主动生成发版的变更记录，也是可行的，这也是为什么团队治理，都在始终强调 git 的提交标准。因为它的确十分有用。

开源一套以教学为目标零碎，欢送 star：github.com/xjjdog/bcma…。它蕴含 ToB 简单业务、互联网高并发业务、缓存利用；DDD、微服务领导。模型驱动、数据驱动。理解大型服务进化路线，编码技巧、学习 Linux，性能调优。Docker/k8s 助力、监控、日志收集、中间件学习。前端技术、后端实际等。次要技术：SpringBoot+JPA+Mybatis-plus+Antd+Vue3。

正文完