Gitlab相关规范【自用】

Commit message 规范

git commit -m "[<type>:<systemScope>][<project>@<taskId/bugId/issueId>]:subject"

type（必填）

commit message 必须包含的内容，用于说明git commit的类别，需要使用下面的标识。

• init : 初始化相关(工程、系统)
• feat : 新功能（feature）
• fix/to : 修复bug，可以是QA发现的BUG，也可以是研发自己发现的BUG。
  • fix : 产生diff并自动修复此问题。适合于一次提交直接修复问题
  • to : 只产生diff不自动修复此问题。适合于多次提交。最终修复问题提交时使用fix
• docs : 文档（documentation）。
• style : 格式（不影响代码运行的变动）。
• refactor : 重构（即不是新增功能，也不是修改bug的代码变动）。
• upgrade/boost/perform : 升级、优化相关，比如提升性能、体验。
• test : 测试相关
• chore / cicd / build : 构建过程或辅助工具的变动
• revert : 回滚到上一个版本。
• version : (本工程的)版本管理、版本发布、源代码相关（含：依赖组件版本管理）
  • dependency : 依赖组件的变更
  • sync : 同步主线或分支的Bug。
  • merge : 代码合并。        

systemScope(可选)

 scope用于说明 commit 影响的系统范围，比如数据层、控制层、视图层等等，视项目不同而不同。

可以是但不限于：

• boot / config : 系统启动相关 / 系统配置相关
• compile : 编译时
• location : 本地
• browser / view / ui : 浏览器 / 页面 / 系统界面
• server : 服务器端
  •   api : 接口
  • controller : 接口的控制器层
  • service : service层
  • dao : dao层
  • common : 公共包

如果你的修改影响了不止一个scope，你可以使用*代替。

project（可选）

 project说明 commit 影响的业务项目范围

例如：VHR / TSP / GATEWAY / ...

subject（必填）

subject是commit目的的简短描述，不超过50个字符。

建议使用中文（感觉中国人用中文描述问题能更清楚一些）。
结尾不加句号或其他标点符号。

参考：

如何规范你的Git commit？-阿里云开发者社区 (aliyun.com)

[GIT] GIT Commit Message 规范 - 千千寰宇 - 博客园 (cnblogs.com)

Merge 流程规范