Git提交规范结合实践
需积分: 0 153 浏览量
2023-04-11
17:08:48
上传
评论
收藏 51KB PDF 举报
代码提交规范
1、提交过程规范
2、commit 内容规范
commit message格式
<type>(<scope>): <subject>
type(必须)
用于说明git commit的类别，只允许使用下面的标识。
标识符 说明
feat 新功能（feature）。
fix 修复bug，可以是QA发现的BUG，也可以是研发自己发现的BUG。注意：如果有bug系统的编号，注意在提交内容中体现，如 #5288
style 注释、格式（不影响代码运行的变动）。
refactor 重构（即不是新增功能，也不是修改bug的代码变动）
perf 优化相关，比如提升性能、体验。
scope(必须)
scope用于说明 commit 影响的范围，如下案例：
场景 规则 scope内容
修改实验预约流程的配方表的程序逻辑或Bug。 明确且唯一的菜单：{一级菜
单}
实验
修改总览列表查询接口 多个菜单 ：{一级菜单1}*{一
级菜单2}
物料*文档*配方*流程
修改全局创建功能 没有菜单：{功能名称} 全局创建
subject(必须)
subject是commit目的的简短描述，不超过50个字符。建议使用中文（感觉中国人用中文描述问题能更清楚一些）。
案例
场景 案例
新增动态模型的功能 feat(动态模型):添加动态页签、动态模型功能
修复创建配方属性显示的问题 fix(配方*流程*实验): , 修复创建配方属性显示的问题#1021
修改权限相关工具类的注释 style(权限管理):修改权限相关工具类的注释
重构配方计算的逻辑 refactor(配方*实验*专项*价格导入):重构配方计算的逻辑
优化权限管理的性能 perf(权限管理):优化权限管理的性能
开发工具相关的 commit规范插件, 用于协助开发人员快速提交：
VS Code:git-commit-plugin
IDEA: Git Commit Template
资源评论
