优雅的Git Commit Message

 源起

不知道大家看到那些非常随意的提交信息会有什么感受,这里可以上一个图给大家感受一下。会不会觉得太过于潇洒和随便了。完全看不出做了哪些变更,在项目正常运作时还好,一旦需要回滚,就很难寻找版本了。

 

 所以,不管是团队开发还是个人开发,遵循统一合理的提交规范是很有必要的,毕竟没有人能记得住一年前的代码吧。

Git Commit Message规范

<type>(<scope>): <subject>

下面分别介绍这几个参数的具体含义和规范

<type>

 用于表示commit的类型,必写。(以下类型大部分来自Angular团队规范

  • feat:新功能
  • fix:bug修复
  • refactor:代码重构
  • docs:文档修改(不影响具体功能)
  • style:样式修改(不影响具体功能)
  • test:测试内容的修改或增加
  • chore:构建流程或依赖管理的变更
  • perf:代码优化:性能提升,安全问题,错误捕捉等
  • revert:代码版本回滚

 <scope>

用于表示commit的影响范围,可以用route, component, utils, build等,也可以使用具体的模块名称或路径、文件夹等来填充

<subject>

作为commit的简单介绍,如果有多个功能点或者修改点最好可以用序号标识,简洁明了为主要目标,一般不超过50个字。

总结

个人认为这种统一友好的格式规范很有必要,我相信好的习惯总会有好的地方。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值