Git Commit 指南

基本准则

• 合理控制 commit 的粒度，每次 commit 只包含一个功能或修复
• 正确设置 commit 时的用户信息，默认 user.name 为姓名拼音、user.email 为公司邮箱
• 在个人开发分支上，通常会提交很多临时的 commit，合并分支后，这些 commit 对浏览记录和代码评审不友好，需要在推送分支前使用 git rebase 合并 commit 并按规范填写注释保持主分支干净整洁

---

Commit message 规范

注意：以下规范中的符号（如冒号、括号）均为中文字符

 

基础格式

<类型>：<描述>
// 空行
<详情> // 选填

---

类型

限定只能使用以下关键词：

• 特性
• 修复
• 优化
• 文档
• 重构
• 其他

---

描述

• 通常 commit 列表只显示第一行文字，因此要用一句话概括本次提交的内容
• 如果 commit 与 issue 相关，则在末尾关闭 issue：（close #id）

---

详情

选填，对本次 commit 的详细描述，建议使用列表的方式书写

---

Commit message 示例

以下均为符合规范的注释：

文档：Commit message 规范

修复：用户注册验证码发送失败（close #123）

特性：用户中心

- 用户注册模块
- 用户登录模块
- 用户信息接口