入职之后,发现自己之前git commit的格式过于随意,也觉得确实要好好重视这件事,此规范是 facebook 公司管理定义的提交规范。
注:并非说这规范就是标准,只是众多规范中我个人比较喜欢的
提交格式
<type>(<scope>): <subject>
// 空一行
<body>
各个标志意义即必要性:
type(必需)scope(可选)subject(必需)body(可选)
-
type用于说明 commit 的类别
-
scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。
-
subject是 commit 目的的简短描述,不超过50个字符。以动词开头,使用第一人称现在时,比如change,而不是changed或changes;第一个字母小写,结尾不加句号(.)
-
Body 部分是对本次 commit 的详细描述,可以分成多行。
范例
fix: feat(0429留言下单): add 'graphiteWidth' option - 提交的具体情况
type 类型
type用于说明 commit 的类别,只允许使用下面8个标识。
注意点
-
是否可运行,每一个版本都应该是可运行的版本
-
选择性提交,commit Message需要详细写好每一个文件中更新了什么,多个不同功能的更改,尽量多次提交
-
如果更改较多,body中好好写清楚每一个文件做了什么改动