优雅的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
    评论
git commit message helper是一个辅助工具,用于帮助我们编写更好的git提交信息。 在进行版本控制时,我们通常会使用git进行代码管理,并且会通过提交(commit)来记录每次的修改。一个好的提交信息可以让其他人更容易理解我们做了哪些修改以及修改的原因。 git commit message helper可以提供以下功能: 1. 提供格式规范:git commit message helper可以为我们提供一份提交信息的格式规范。这样,在编写提交信息时,我们可以按照这个规范来进行,以遵循一致的风格。 2. 提示关键信息:git commit message helper可以通过自动补全或显示相关选项来提示我们填写关键信息。比如,当我们输入某个关键词时,它可以自动给出一些常见的选项供我们选择,以避免遗漏重要信息或填写错误。 3. 语法检查:git commit message helper可以帮助我们进行提交信息的语法检查。它可以检查是否符合规范,是否存在拼写错误等,从而提供更准确的提交信息。 4. 快捷操作:git commit message helper可以提供一些快捷操作,以便更方便地编写提交信息。比如,可以设置快捷键或命令来快速填写某些常用的信息,如修改的模块、bug修复等。 总而言之,git commit message helper是一个实用工具,可以帮助我们编写更好、更准确的提交信息。它不仅可以提高版本控制的效率,还有助于团队合作和代码维护的规范性。使用这个工具可以在一定程度上提高代码开发和管理的效果。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值