提示

本文已归类进系列文章中，若要了解 git 的更多信息，请查看 笔记 - 备忘录 - Git提交信息规范。

在使用 git commit -m 时，遵循规范的提交信息格式可以提高代码可读性、协作效率和版本管理质量。

以下是常见的提交规范建议：

1. 基础格式

<类型>(<作用域>): <主题>

• 类型：说明提交的类别（必填）
• 作用域：可选，说明影响的范围（如模块、组件）
• 主题：简明扼要的提交描述

---

2. 常用提交类型（Type）

类型	说明
feat	新增功能
fix	修复 bug
docs	文档变更（如 README、注释）
style	代码格式调整（不影响逻辑，如空格、分号）
refactor	代码重构（既非新增功能，也非修复 bug）
perf	性能优化
test	测试相关（新增或修改测试用例）
chore	构建/工具/依赖变更（如修改 CI、更新依赖包）
revert	回退某次提交

---

3. 作用域（Scope）

• 可选字段，用括号包裹，说明代码影响的范围（如模块、组件）
  例如：fix(login): 修复登录按钮样式问题

---

4. 主题（Subject）

• 简明扼要：控制在 50 字符以内
• 首字母小写：无需大写或句号结尾
• 使用祈使语气：如 "add" 而不是 "added" 或 "adds"

---

5. 示例

# 标准提交
git commit -m "feat(user): 新增用户注册功能"

# 带作用域的修复
git commit -m "fix(auth): 修复 OAuth 令牌过期问题"

# 文档更新
git commit -m "docs(api): 补充接口返回示例"

# 代码重构
git commit -m "refactor(utils): 优化日期格式化函数"

---

6. 避免的写法

• ❌ git commit -m "update code" （过于模糊）
• ❌ git commit -m "fix bug" （未说明具体问题）
• ❌ git commit -m "修改了一些东西" （非英文或未遵循类型规范）

---

7. 复杂提交建议

如果提交需要详细说明，建议省略 -m 直接进入编辑器编写多行信息：

git commit

格式示例：

feat(dashboard): 新增数据统计面板

- 添加用户活跃度图表
- 集成实时数据 API
- 优化图表响应式布局

Closes #123

---

遵循规范能让团队协作更高效，也方便通过 git log 快速追踪变更历史。