你的git commit规范吗?看完从此commit不迷茫

本文介绍了如何制定和遵循Git提交信息的规范,强调了其重要性。 commit message应包含类型(如feat, fix, docs等)、影响范围和简短描述。规范化的提交能提高团队协作效率,便于代码审查和历史追踪。建议在开源项目中使用英文,并关联issue。通过实例展示了规范化的git commit实践,倡导在团队中推广这一良好习惯。
摘要由CSDN通过智能技术生成

神奇的git commit

一般情况下我们的git commit message应该简单明了,说明本次提交的目的,具体干了啥。

但是在日常开发中要么改的太多懒得写了,要么bugs修的太多懒得写。有时候中英文混用亦或者fix bugs漫天飞舞,有时候去问「前人」你这修的啥:忘了,你自己看看代码变动吧……

废话少说,上规范

commit message格式

<type>(<scope>): <subject>
<commit类型>(影响范围): 具体描述

举例 fix(DAO): fixed invalid user table indexes.

type

type指明git commit的类别,应该使用以下类型,也可根据团队自行增减

  • 『feat』: 新增功能
  • 『fix』: 修复 bug
  • 『docs』: 仅仅修改了文档,比如 README, CHANGELOG等等
  • 『test』: 增加/修改测试用例,包括单元测试、集成测试等
  • 『style』: 修改了空行、缩进格式、引用包排序等等(不改变代码逻辑)
  • 『perf』: 优化相关内容,比如提升性能、体验、算法等
  • 『refactor』: 代码重构,「没有新功能或者bug修复」
  • 『chore』: 改变构建流程、或者增加依赖库、工具等
  • 『revert』: 回滚到上一个版本
  • 『merge』: 代码合并

scope(可选)

scope用于说明 commit 影响的范围,根据不同项目有不同层次描述。若没有特殊规定,也可以描述影响的哪些功能等。

subject

subject是commit目的的简短描述,不超过50/80个字符,一般git提交的时候会有颜色提示。

  • 若英文用不惯,那么推荐使用中文

  • 若是开源代码,一律推荐统一英文,英文不行可以翻译软件用起来

  • 若是开源代码,可以再附加对应的issue地址

  • 结尾不加标点符号

oh-my-zsh git commit示例

这里给出常用的oh-my-zsh的git commit的截图,采用的就是上述规范,看起来简单明了非常高效

总结

规范git commit是团队必不可少的功课,每一条规范的git commit都是对团队的负责,也是对自身代码约束的负责。

希望以上内容对大家有所帮助,如果觉得可行希望你能带头在团队用起来,不仅对自己有帮助对团队帮助更大。

如果觉得内容可以的话点个赞呗~

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值