咸鱼翻身记

Git commit 规范

2021/8/6 Git

# 规范格式

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

# type(必须)

  1. feat：新功能（feature）。
  2. fix/to：修复 bug，可以是 QA 发现的 BUG，也可以是研发自己发现的 BUG。
    • fix：产生 diff 并自动修复此问题。适合于一次提交直接修复问题
    • to：只产生 diff 不自动修复此问题。适合于多次提交。最终修复问题提交时使用 fix
  3. docs：文档（documentation）。
  4. style：格式（不影响代码运行的变动）。
  5. refactor：重构（即不是新增功能，也不是修改 bug 的代码变动）。
  6. perf：优化相关，比如提升性能、体验。
  7. test：增加测试。
  8. chore：构建过程或辅助工具的变动。
  9. revert：回滚到上一个版本。
  10. merge：代码合并。
  11. sync：同步主线或分支的 Bug。

# scope(可选)

scope 用于说明 commit 影响的范围，比如数据层 Model、持久层 DAO、服务层 Service、控制层 Controller、视图层 View 等等，视项目不同而不同。如果你的修改影响了不止一个 scope，你可以使用*代替。

# subject(必须)

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

  • 建议使用中文。
  • 结尾不加句号或其他标点符号。

# 总结

根据以上规范 git commit message 将是如下的格式

fix(DAO):用户查询缺少username属性
feat(Controller):用户查询接口开发
1
2

这样规范 git commit 到底有哪些好处呢？

  • 便于程序员对提交历史进行追溯，了解发生了什么情况。
  • 一旦约束了 commit message，意味着我们将慎重的进行每一次提交，不能再一股脑的把各种各样的改动都放在一个 git commit 里面，这样一来整个代码改动的历史也将更加清晰。
  • 格式化的 commit message 才可以用于自动化输出 Change log。