Git Commit Specification(Commit 规范)

Git Commit Specification

规范是…. @firestaradmin

---

规范梳理

初期我们在互联网上搜索了大量有关git commit规范的资料，但只有Angular规范是目前使用最广的写法，比较合理和系统化，并且有配套的工具（IDEA就有插件支持这种写法）。最后综合阿里巴巴高德地图相关部门已有的规范总结出了一套git commit规范。

Commit Message Format

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

<type>

type 用于说明commit 的类别，只允许使用下面的标识。

• feat：新功能（feature）。

• fix/to：修复bug，可以是QA 发现的BUG，也可以是研发自己发现的BUG。

  • fix：产生diff(差异) 并自动修复此问题。适合于一次提交直接修复问题

  • to：只产生diff 不自动修复此问题。适合于多次提交。最终修复问题提交时使用fix

• docs：文档（documentation）。

• style：格式（不影响代码运行的变动）。

• refactor：重构（即不是新增功能，也不是修改bug的代码变动）。

• perf：优化相关，比如提升性能、体验 (performance)。

• test：增加测试。

• chore：构建过程或辅助工具的变动。

• revert：回滚到上一个版本。

• merge：代码合并。

• sync：同步主线或分支的Bug。

---

<scope>

scope用于说明commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。

例如在Angular，可以是location，browser，compile，rootScope， ngHref，ngClick，ngView等。如果你的修改影响了不止一个scope，你可以使用*代替。

当然，scope 也可以是文件名称，如：

fix(http.c):http请求端口错误

---

<subject>

subject是commit目的的简短描述，不超过50个字符。

可以使用中文或英文，只要你能描述清楚，以后回头看也能快速明白理解即可。

• 结尾不加句号或其他标点符号。
• 根据以上规范git commit message将是如下的格式：

fix(UserLogin Module):用户查询缺少username属性 
feat(Controller):用户查询接口开发
fix(http.c):http请求端口错误

good:

以上梳理的git commit 规范，有哪些好处呢？

• 便于程序员对提交历史进行追溯，了解发生了什么情况。

• 一旦约束了Commit Message，意味着我们将慎重的进行每一次提交，不能再一股脑的把各种各样的改动都放在一个Commit 里面，这样一来整个代码改动的历史也将更加清晰。

• 格式化的Commit Message 才有利于于自动化输出Change log。

Sample:

# Commit
git commit -m "fix(UserLogin Module):用户查询缺少username属性"
git commit -m "feat(Controller):用户查询接口开发"
git commit -m "fix(http.c):http请求端口错误"



# 搜索跟 http.c 文件相关的历史记录
git log HEAD --grep chore(http.c)