Git 提交规范建议 #1

New Issue

2025-12-16T07:24:53+08:00

fanjc commented

2025-12-16 07:24:53 +08:00

Git 提交规范建议

一、核心原则

提交信息需清晰体现「修改类型」「影响范围」和「具体内容」，便于团队协作、代码回溯

二、常用标签（类型+格式）

标签	适用场景	示例格式
`feat`	新增功能（如新增接口、页面模块）	`feat(用户模块): 新增手机号登录功能`
`fix`	修复 bug（如逻辑错误、显示异常）	`fix(订单页): 修复结算金额计算错误`
`docs`	仅修改文档（如 README、注释、接口文档）	`docs(api): 更新支付接口参数说明`
`style`	代码格式调整（无逻辑变更，如缩进、空格）	`style(utils): 统一函数括号格式`
`refactor`	代码重构（既不新增功能也不修复 bug）	`refactor(列表页): 拆分复杂渲染函数`
`test`	新增/修改测试代码（如单元测试、集成测试）	`test(login): 补充登录失败场景测试`
`chore`	构建/工具相关修改（如依赖更新、配置调整）	`chore: 升级 eslint 至 9.0.0`

三、提交信息结构

[标签(影响范围)]: 简述修改内容（不超过50字）
- 具体修改1：说明细节（如“调整用户表手机号字段校验规则” 改动影响过大推荐加入修复文件 如“涉及 src/views/UserForm.vue、src/utils/validate.js”）

示例

fix(购物车): 修复商品删除后数量未实时更新问题
- 补充删除事件的数量重算逻辑

四、注意事项

「影响范围」可省略（如全局配置修改：chore: 调整打包输出路径）；
简述需简洁，避免冗余（不用“修改了xxx的bug”，直接写“修复xxx问题”）；
多修改点用 - 分点说明，清晰区分不同变更。

# Git 提交规范建议 ## 一、核心原则提交信息需清晰体现「修改类型」「影响范围」和「具体内容」，便于团队协作、代码回溯 ## 二、常用标签（类型+格式） | 标签 | 适用场景 | 示例格式 | |------------|-------------------------------------------|-----------------------------------| | `feat` | 新增功能（如新增接口、页面模块） | `feat(用户模块): 新增手机号登录功能` | | `fix` | 修复 bug（如逻辑错误、显示异常） | `fix(订单页): 修复结算金额计算错误` | | `docs` | 仅修改文档（如 README、注释、接口文档） | `docs(api): 更新支付接口参数说明` | | `style` | 代码格式调整（无逻辑变更，如缩进、空格） | `style(utils): 统一函数括号格式` | | `refactor` | 代码重构（既不新增功能也不修复 bug） | `refactor(列表页): 拆分复杂渲染函数`| | `test` | 新增/修改测试代码（如单元测试、集成测试） | `test(login): 补充登录失败场景测试` | | `chore` | 构建/工具相关修改（如依赖更新、配置调整） | `chore: 升级 eslint 至 9.0.0` | ## 三、提交信息结构 ``` [标签(影响范围)]: 简述修改内容（不超过50字） - 具体修改1：说明细节（如“调整用户表手机号字段校验规则” 改动影响过大推荐加入修复文件如“涉及 src/views/UserForm.vue、src/utils/validate.js”） ``` ### 示例 ``` fix(购物车): 修复商品删除后数量未实时更新问题 - 补充删除事件的数量重算逻辑 ``` ## 四、注意事项 1. 「影响范围」可省略（如全局配置修改：`chore: 调整打包输出路径`）； 2. 简述需简洁，避免冗余（**不用“修改了xxx的bug”，直接写“修复xxx问题”**）； 3. 多修改点用 `-` 分点说明，清晰区分不同变更。

fanjc commented

2025-12-16 07:27:03 +08:00

影响范围之外分 commit 提交，不同影响范围的修改需拆分独立 Commit，避免一个 Commit 包含跨模块 / 跨功能的变更。

![image.png](/attachments/fe7a0b5a-9b8f-45cd-b2bc-12f984e57896) 影响范围之外分 commit 提交，不同影响范围的修改需拆分独立 Commit，避免一个 Commit 包含跨模块 / 跨功能的变更。

image.png

77 KiB

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: fanjc/HighwayEventDet#1