提交规范了解一下git commit 提交规范

Posted LyCat_00

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了提交规范了解一下git commit 提交规范相关的知识,希望对你有一定的参考价值。

git commit 提交规范

commit message格式:

<type>(<scope>): <subject>
  • type(必须):用于说明git commit的类别,只允许使用下面的标识。
    • 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 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。
  • subject(必须):subject是commit目的的简短描述,不超过50个字符。

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

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

fix(DAO):修复路由bug
feat(Controller):用户查询接口开发

以上是关于提交规范了解一下git commit 提交规范的主要内容,如果未能解决你的问题,请参考以下文章

规范git commit提交记录和版本发布记录

Git提交规范

Git Commit Log提交规范

Git commit提交规范

Git代码提交规范

Git提交规范