曾经年少的我,不知道Commit message的重要性,以至于某次版本回退的时候,望着眼前的一个个Commit message,一脸懵逼。
不跟你多BB,接下来说下正确的书写方式,主要参考阮大神的博客,并基于自己的项目经验,总结如下:
Commit message的格式:
<type>(scope): desc
-
type用来说明类型,常用的有以下几种:
- feat:完成新功能的开发
- fix:代码BUG的修复
- style:样式的修改
- refactor:代码重构
- docs:文档
- chore:构建工具
scope用来说明此次变动影响的范围或文件
desc用来简短描述此次的变动,描述只要简明易理解就好,没必要写很多
举例:
feat(deployment.js): 新增应用发布功能