Git 提交代码规范

229 阅读1分钟

提交格式

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

// 空一行

<body>`

各个标志意义即必要性:

type(必需)scope(可选)subject(必需)body(可选)

  • type用于说明 commit 的类别

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

  • subject是 commit 目的的简短描述,不超过50个字符。以动词开头,使用第一人称现在时,比如change,而不是changed或changes;第一个字母小写,结尾不加句号(.)

  • Body 部分是对本次 commit 的详细描述,可以分成多行。

范例

fix: feat(****): 说明 - m

type 类型

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

  1. feat :新功能
  2. fix :修复bug
  3. doc : 文档改变
  4. style : 代码格式改变
  5. refactor :某个已有功能重构
  6. perf :性能优化
  7. test :增加测试
  8. build :改变了build工具 如 grunt换成了 npm
  9. revert: 撤销上一次的 commit