git commit规范

git commit规范

commit message格式

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

type(必须)

用于说明git commit的类别,只允许使用下面的标识。

1. 添加新功能

feat

fix/to:修复bug,可以是QA发现的BUG,也可以是研发自己发现的BUG。

· fix:产生diff并自动修复此问题。适合于一次提交直接修复问题

· to:只产生diff不自动修复此问题。适合于多次提交。最终修复问题提交时使用fix

2. 添加文档(documentation)

docs

3. 修改/添加样式格式(不影响代码运行的变动)

style

4. 代码重构(即不是新增功能,也不是修改bug的代码变动)

refactor

5. 优化:优化相关,比如提升性能、体验

perf

6. 增加测试

test

7. 构建过程或辅助工具的变动

chore

8. 回滚到上一个版本

revert

9. 代码合并

merge

10. 同步主线或分支的Bug

sync

scope(可选)

scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。

例如在Angular,可以是location,browser,compile,compile,rootScope, ngHref,ngClick,ngView等。如果你的修改影响了不止一个scope,你可以使用*代替。

subject(必须)

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

建议使用中文(感觉中国人用中文描述问题能更清楚一些)。

· 结尾不加句号或其他标点符号。

· 根据以上规范git commit message将是如下的格式:

fix(DAO):用户查询缺少username属性

feat(Controller):用户查询接口开发

  • 6
    点赞
  • 8
    收藏
    觉得还不错? 一键收藏
  • 1
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值