写有意义的提交记录说明

编写有意义的 Git 提交记录说明对于项目的版本管理和团队协作非常重要。

要点

1. 遵循规范格式

• 通常采用类似 “类型 (范围): 简短描述” 的格式。例如：
  • feat (user): 添加用户注册功能
  • fix (api): 修复登录接口的密码加密错误

2. 简洁明了

• 保持说明简短，一般不超过 50 个字。例如：“refactor: 优化数据库查询代码，提升性能”。
• 避免冗长复杂的句子和过多细节，专注于本次提交的核心变化。

3. 描述变化内容

• 清晰说明代码做了什么修改，而不是解释为什么修改（在项目文档或代码注释中解释原因更好）。例如：“add: 增加商品库存管理模块的库存预警功能”。
• 如果是修复 bug，提及修复的问题症状，如：“fix: 解决订单提交时金额计算错误导致支付失败的问题”。

4. 使用动词开头

• 以有意义的动词开头，如 “add”（添加）、“update”（更新）、“remove”（移除）、“fix”（修复）、“refactor”（重构）等，使读者能快速了解提交的动作类型。

5. 提及相关范围或模块

• 指出修改涉及的项目范围或特定模块，有助于其他开发人员快速定位受影响的部分。比如 “style (navbar): 调整导航栏样式”。

6. 保持一致性

• 在整个项目中遵循统一的提交说明风格，方便团队成员阅读和理解历史提交记录。 例如，如果团队决定使用英文编写提交说明，就都使用英文，并且保持格式和用词习惯的一致。

7. 参考相关问题或任务

• 如果提交是针对某个特定的问题跟踪系统（如 GitHub Issues）中的任务或问题，在说明中提及相关的问题编号或链接，例如：“closes #123: 实现用户反馈功能”，这有助于建立提交与项目管理任务之间的联系。

案例

• 功能新增：

  • feat(auth): 实现短信验证码登录功能
  • feat(product): 增添商品详情页的图片放大查看功能

  Bug 修复：

  • fix(cart): 修正购物车中商品数量修改后总价未实时更新的问题
  • fix(order): 解决订单状态在特定网络条件下显示错误的情况

  代码重构：

  • refactor(utils): 重构工具函数库，提高代码复用性
  • refactor(ui-components): 对表单组件进行结构优化，增强可维护性

  样式调整：

  • style(header): 更改网站头部的背景颜色和字体样式
  • style(footer): 调整页脚的布局与文字对齐方式

  文档更新：

  • docs(readme): 完善项目 README 文件中的 API 调用说明
  • docs(guide): 补充开发指南中关于数据库配置的详细步骤