当前位置:   article > 正文

Git commit提交规范_git commit subject

git commit subject

引言

使用git管理代码的同行,我们经常能看到其他人代码提交时的备注写的过长,有的看不懂,有的太过简洁,本文旨在简单说明git commit提交的规范,规范提交内容。

git commit template 

提交格式<type>(<scope>): <subject>
格式对应说<commit类型>(影响范围可选): 具体描述
举例 fix(DAO): 修复xxBug。

 type

类型说明
feat新功能
fix修补bug
docs文档
style格式(不影响代码运行的变动)
refactor重构(即不是新增功能,也不是修改bug的代码变动)
test增加测试
chore构建过程或辅助工具的变动
perf性能优化
build打包
ci持续集成

 scope(可选)

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

subject

subject是 commit 目的的简短描述,不超过50个字符。

  • 以动词开头,使用第一人称现在时,比如change
  • 结尾不加标点符号
  • 第一个字母小写 

栗子

fix(mybatis):修复sql查询bug
声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/天景科技苑/article/detail/968130
推荐阅读
相关标签
  

闽ICP备14008679号