当前位置:   article > 正文

【git】提交规范和开发工具_google git提交规范

google git提交规范

git 提交规范

转自知乎阿里技术

commit message 格式 : <type>(<scope>): <subject>

  • 一、type(必须): 用于说明git commit的类别,只允许使用下面的标识。
  1. fix/to:修复bug,可以是QA发现的BUG,也可以是研发自己发现的BUG。
    fix:产生diff并自动修复此问题。适合于一次提交直接修复问题
    to:只产生diff不自动修复此问题。适合于多次提交。最终修复问题提交时使用fix
  2. docs:文档(documentation)。
  3. style:格式(不影响代码运行的变动)。
  4. refactor:重构(即不是新增功能,也不是修改bug的代码变动)。
  5. perf:优化相关,比如提升性能、体验。
  6. test:增加测试。
  7. chore:构建过程或辅助工具的变动。
  8. revert:回滚到上一个版本,还原。
  9. merge:代码合并。
  10. sync:同步主线或分支的Bug。
  11. feat:新功能(feature)
  12. ci 持续集成
  13. types 类型定义文件更改
  14. wip 开发中
  15. release 发布新版本
  • 二、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):用户查询接口开发

表情

表情代码代表内容
:sparkles:添加新功能
声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/article/detail/46305
推荐阅读
相关标签