git commit规范格式

前言:规范代码提交的命名以及流程,虽然从事的都不是专业开发,但是这个点需要向他进行学习,这边的话简单记录一些git commit开发准则规范的记录

参考文章:https://zhuanlan.zhihu.com/p/182553920

commit message格式

commit内容的格式主要分为三个Header,Body 和 Footer,如下所示

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

根据以上规范git commit message规则,完整的commit的格式内容是如下所示

fix(DAO):用户查询缺少username属性
feat(Controller):用户查询接口开发

type(必须)

commit message中的type指的是commit的类型,其中包含下面这些点,但是这边说下常用的也就是其中的几个,分别是feat,fix,refactor,merge,git。

注意点:在一次commit的规范中,这个type的类型是一定要有的。

commit类型

用于说明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 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。

比如Java Web开发中,MVC分为controller,service层,view层,dao层,在这类项目上开发的时候scope就可以为这几个。

subject字段(必须)

subject是commit的简短描述,不超过50个字符。比如是修复一个 bug 或是增加一个 feature,类型如下:

1. fix(DAO):用户查询缺少username属性
2. feat(Controller):用户查询接口开发
posted @   zpchcbd  阅读(448)  评论(0编辑  收藏  举报
相关博文:
阅读排行:
· 开源Multi-agent AI智能体框架aevatar.ai,欢迎大家贡献代码
· Manus重磅发布:全球首款通用AI代理技术深度解析与实战指南
· 被坑几百块钱后,我竟然真的恢复了删除的微信聊天记录!
· 没有Manus邀请码?试试免邀请码的MGX或者开源的OpenManus吧
· 园子的第一款AI主题卫衣上架——"HELLO! HOW CAN I ASSIST YOU TODAY
历史上的今天:
2020-03-22 Thinkphp 3.2.3 parseWhere设计缺陷导致的exp注入 (三)
2020-03-22 Thinkphp 3.2.3 parseWhere设计缺陷导致的exp注入 (二)
2020-03-22 Thinkphp 3.2.3 parseWhere设计缺陷导致的exp注入 (一)
点击右上角即可分享
微信分享提示