调用博主最近登录时间
生活中的HYGGE
Git代码Commit规范
Git

Git代码Commit规范

hygge
2022-09-12 / 0 评论 / 22 阅读 / 正在检测是否收录...

l7ymcyuw.png

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

规范git commit到底有哪些好处呢?

  • 便于程序员对提交历史进行追溯,了解发生了什么情况。
  • 一旦约束了commit message,意味着我们将慎重的进行每一次提交,不能再一股脑的把各种各样的改动都放在一个git commit里面,这样一来整个代码改动的历史也将更加清晰。
  • 格式化的commit message才可以用于自动化输出Change log。

type(必须)

用于说明git commit的类别,只允许使用下面的标识。
typedesc
feat新功能(feature)
fix/to修复bug,可以是QA发现的BUG,也可以是研发自己发现的BUG。fix:产生diff并自动修复此问题。适合于一次提交直接修复问题。to:只产生diff不自动修复此问题。适合于多次提交。最终修复问题提交时使用fix
docs文档(documentation)
style格式(不影响代码运行的变动)
refactor重构(即不是新增功能,也不是修改bug的代码变动)。
perf优化相关,比如提升性能、体验。
test增加测试。
chore构建过程或辅助工具的变动。
revert回滚到上一个版本。
merge代码合并。
sync同步主线或分支的Bug。

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):用户查询接口开发
0

评论 (0)

取消