git-commit-convention_Version3

Git Commit 提交规范说明

规范的 Git 提交信息有助于团队协作、代码回溯、自动化工具集成（如 changelog 生成、语义化发布等）。本规范参考 Conventional Commits 和主流开源社区实践，适合各类前端/后端项目。

1. 基本格式

每次提交，建议使用如下格式：

<type>(<scope>): <subject>

<BLANK LINE>
[optional body]

<BLANK LINE>
[optional footer]

说明：

• type：提交类型（必填）
• scope：影响范围（可选，建议填写模块名/文件夹名等）
• subject：简要描述本次改动（不超过50字，首字母小写，结尾不加句号）
• body：详细描述（可选），解释为什么做这样的修改、与之前行为的对比等
• footer：脚注（可选），如 BREAKING CHANGE、关联 issue 等

2. 常用 type 类型

3. 示例

新增功能

feat(user): 新增用户注册接口

修复缺陷

fix(login): 修复记住密码功能失效问题

文档编写

docs: 完善项目 README 说明

重构代码

refactor(api): 重构接口数据结构，优化可读性

性能优化

perf(list): 优化大列表渲染性能

其他

chore: 升级依赖包至最新版本
style: 调整代码缩进和空格
test: 新增用户模块单元测试
build: 配置打包脚本支持生产环境
ci: 修复 CI 构建环境变量问题
revert: revert: "feat(auth): 增加JWT登录"

4. 关联 Issue 及 BREAKING CHANGE

关联 Issue

fix(router): 修复路由跳转丢失参数问题

Closes #123

重大变更

feat(api): 用户登录接口参数变更

BREAKING CHANGE: 登录接口不再兼容原有参数格式，前端需同步调整

5. 自动化工具推荐

• commitizen：交互式提交，规范 commit 格式
• commitlint：校验 commit 信息
• cz-customizable：自定义 commitizen 配置

6. 提交建议

• 提交前请自查 message 是否规范、内容是否准确表达修改意图
• 一次 commit 做一件事，避免大而杂的提交
• 若有疑问，优先参考已有提交历史或本说明

统一且清晰的 Git 提交规范，将大大提升团队协作效率和项目可维护性。