提交规范

原创📝 chandler📆 2024-04-17 21:16

参数说明

类型	含义
feat	新功能（feature）
fix	修补bug
docs	文档
style	格式化
refactor	重构
perf	性能
test	增加测试或者修改测试
build	影响构建系统或外部依赖项的更改
ci	对CI配置文件和脚本的更改
chore	对非 src 和 test目录的修改
revert	撤销提交

编号前缀说明

如果未区分，则任务单不允许和缺陷单号重复

符号	名称	含义	样例
T	Task	任务单	T128
B	Bug	缺陷单	B23

提交检查

1. 代码提交之前必须要在本地checkstyle，确保检查通过

2. 代码提交之前必须要在本地install，确保编译通过

普通提交

提交格式

类型(任务编号/缺陷编号，多个使用英文逗号隔开): 不超过50字的中文描述

提交样例

无任务号的

如果没有任务号，则任务号默认为0，不可为空

feat

feat(0): 新增用户添加接口

fix

fix(0): 修复了用户登录问题

有任务号的

feat

# 区分编号前缀
feat(T128): 新增用户添加接口

# 不区分编号前缀
feat(128): 新增用户添加接口

fix

# 区分编号前缀
fix(B23): 修复了用户登录问题

# 不区分编号前缀
fix(23): 修复了用户登录问题

多任务号的

首先我们建议每个任务开发完就赶紧提交，尽量每次改动的内容仅涉及本任务，多任务如果没有互相依赖的情况下我们建议拆分到各自任务上进行提交

# 区分编号前缀
feat(T128,T129): 新增添加用户接口、修改用户接口开发

# 不区分编号前缀
feat(128,129): 新增添加用户接口、修改用户接口开发

合并提交

提交格式

类型(任务编号/缺陷编号，多个使用英文逗号隔开): 不超过50字的中文描述

# 在内容区填写
任务编号1 该任务的大致描述
缺陷编号2 该缺陷的大致描述

Close 任务号/缺陷号

提交样例

区分编号前缀

feat(T128) 新增添加用户的接口开发

fix(T23) 修复的用户登录失败的问题

Close T128,T23

不区分编号前缀

feat(128) 新增添加用户的接口开发

fix(23) 修复的用户登录失败的问题

Close 128,23