在日常的开发工作中,我们团队所有的项目都是使用Git来做版本管理的 。Git是个很强大的版本管理工具,像全球最大的同性交友网站Github就是基于Git的 。
如此强大的版本管理工具,在实际的应用中,我们很多的时候却没有发挥它的作用,而且还把它用的超级烂,其中最明显的就是Commit message 。
实际项目提交记录在项目中存在大量提交,每一次提交都意味着系统的一次更新,但是从提交信息中我们很难分辨出某一次提交具体解决了什么问题,增加了什么功能 。提交内容如下:
文章插图
打开一次提交记录,我们还会发现在一次提交中,融合了太多的功能:
- 修复了一个bug
- 优化了代码结构
- 增加了一个新功能
- 等等
优秀开源项目提交记录接下来我们在看看优秀的开源项目是如何提交记录的 。
文章插图
上面的提交记录是我从Angular项目中截取的,我们可以清晰的看到每一次提交都做了什么,commit message都使用了简明的文字描述了提交内容 。
打开提交记录,我们会发现提交内容和message非常匹配,一次提交绝不会包含和本次提交目的无关的内容 。这样提交代码,可以很方便的进行代码Review 。
Commit Message规范参考优秀的开源项目,我们可以很好的总结出一套message的格式规范:
文章插图
总结参考并使用总结出来的这套规范,可以是我们版本管理更清晰,使我们的项目走向优秀更进一步 。
推荐阅读
- 雨水节气的“古诗词大会” 你的“诗心”还在吗?
- 关于工资条,这6个常识必须掌握,事关你的权益
- 无公害茶叶规范化栽培技术介绍
- 医院装修设计规范
- |职场黄金五年,决定你的一生(六)
- 磐安县,规范茶叶采摘技术 保证茶叶质量和声誉
- 别画大饼了!那根本激励不了你的员工
- 糖尿病吃什么好 3款药膳稳住你的血糖
- 痛经难忍 请善待你的“大姨妈”
- 优化你的SpringBoot