Skip to main content

Git commit 规范

格式:<type>(<scope>): <subject>

举例:feat(user): 新增用户管理

type说明:必须,√为常用

  • feat:√ 新功能,新需求,新模块
  • fix:√ bug修改
  • perf:√ 优化相关,比如提升性能、体验。
  • docs:√ 修改说明文档,注释
  • chore:√ 构建过程或辅助工具的变动。
  • refactor: 重构(即不是新增功能,也不是修改bug的代码变动)
  • test: 增加测试。
  • style: 格式调整,不影响代码运行的变动
  • revert: 回滚到上一个版本。
  • merge: 代码合并。

scope说明:非必须

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

  1. 前端项目,可以用componment文件名称,view文件名称等
  2. java后端项目,可以类名,或者模块名
  3. python后端项目,可以文件名,或者模块名
  4. quickdata项目, 使用项目名或者公共组件名
  5. quickend项目, 使用项目名或者公共组件名

subject说明:必须

subject是commit目的的简短描述,不超过50个字符。使用中文,描述清晰