JingBin's Home

Git commit 规范

与道人之短,勿说己之长;人骂之一笑,人誉之一笑。 - 齐白石/国画大师

git提交估计也快上万次了,每次不知道怎么写好,今天在网上找到一套规范然后加上常用的一些,总结出来一套 Git commit 规范,没有强制的规定,主要是翻阅以前的日志会更清晰。


type: description

type 是 commit 的类别,只允许如下几种标识:

  • fix: 修复bug
  • add: 新功能
  • update: 更新
  • refactor : 某个已有功能重构
  • perf : 性能优化
  • style : 代码格式改变
  • test: 增加测试代码
  • docs : 文档改变
  • revert: 撤销上一次的commit
  • build: 构建工具或构建过程等的变动,如:关联包升级等

description 是对本次提交的简短描述:

  • 不超过50个字符。
  • 推荐以动词开头,如: 设置、修改、增加、删减、撤销等