git commit message规范
<type>(<scope>): <subject>
// 空一行
<body>
- type:必须;
- scope:可选;
- subjecct:必须;
- body:可选;
例子:
feat *: 开发系统用户管理功能
本次开发的系统用户管理功能,包括:
- 系统登录
- 忘记密码
- ...
- ...
type规范(必选)
type有9种,也可继续自定义:
- feat:提交新功能(feature);
- fix:提交bug修复补丁;
- docs:编写文档(documentation);
- style: 调整代码格式(不影响代码运行的变动);
- refactor:对代码进行重构(即不是新增功能,也不是修改bug的代码变动);
- test:提交对代码的测试;
- chore:构建过程或辅助工具的变动;
- revert:撤销之前的提交;
- pref:对代码进行性能优化(不影响代码运行、也不对代码进行重构);
scope规范(可选)
scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目分层架构不同而不同。
subject规范(必选)
subject 是 commit 目的的简短描述,不超过 50 个字符。
注意:subject
结尾不要添加标点符号。
body规范
Body是对这次提交的详细描述,可分为多行。