当前位置：首页 > news >正文

git-Git约定式提交

news 2025/11/17 9:06:36

是一套标准化的提交信息规范，核心目的是让提交的历史清晰可读，自动化生成变更日志，支持语义化版本管理。

<type>(scope): <subject>

type：提交类型(必须)，如feat，feat，fix，docs，style，refactor，test

scope：可选，表示影响的模块（如user，api，form）

subject：简短描述(必须)，说明做了什么

示例

git commit -m "fix: 修改了对应的代码解构优化"

在 Conventional Commits 规范中，type 和 subject 之间必须有一个空格，且冒号 : 后必须跟一个空格。

新增按钮、新页面、新接口、新交互逻辑

git commit -m "feat(login): 新增短信验证码登录功能"
git commit -m "feat(shop): 支持商品多规格选择（颜色+尺寸）"

接口报错、表单校验失效、样式错乱、逻辑漏洞

git commit -m "fix(user): 修复个人资料保存后昵称不刷新的问题"
git commit -m "fix(api): 修复分页参数为 0 时返回空数据的 Bug"

git commit -m "style: 统一代码缩进为 2 空格（Prettier 格式化）"
git commit -m "style(utils): 修正函数命名（userInfo → userinfo）"

更新 README、补充注释、修改接口文档、调整使用说明

git commit -m "docs: 补充编辑器组件的图片上传配置说明"
git commit -m "docs(api): 更新用户接口的参数说明（新增 gender 字段）"

拆分过大的函数、合并重复代码、调整目录结构、优化变量命名

git commit -m "refactor(order): 拆分订单提交逻辑为独立函数"
git commit -m "refactor(utils): 重构日期格式化工具（简化参数）"

补充单元测试（Jest）、集成测试、修复测试用例失败问题

git commit -m "test(login): 新增短信登录的单元测试用例"
git commit -m "test(user): 修复个人资料更新的测试断言错误"

类型	说明
`feat`	新增功能（会触发语义化版本的 MINOR 升级）
`fix`	修复 Bug（会触发语义化版本的 PATCH 升级）
`docs`	仅修改文档（如 README、注释等，不影响代码逻辑）
`style`	代码格式调整（如缩进、空格、格式化，不改变代码功能）
`refactor`	代码重构（既不新增功能，也不修复 Bug，如重构函数、优化结构）
`perf`	性能优化（如提升接口响应速度、减少内存占用）
`test`	新增 / 修改测试用例（如单元测试、集成测试）
`build`	影响构建系统或外部依赖的修改（如 Webpack 配置、npm 依赖版本变更）
`ci`	持续集成（CI）配置修改（如 GitHub Actions、Jenkins 脚本调整）
`chore`	其他不修改 src 和 test 的琐碎变动（如清理日志、修改配置文件）
`revert`	回滚之前的提交（需在描述中说明回滚的提交哈希，如 `revert: feat: 新增登录功能`）