Git 提交规范主要有以下几点:
1、提交信息格式:每一次提交需要包含一条简洁明了的提交信息,格式为:
<类型>(范围): 描述信息
[可选] <体验改进或破坏性>: 详细信息
例如:
feat(search): 添加类目搜索功能
[BREAKING CHANGE]: 移除了原有(非用户)搜索接口
- 2、提交信息内容:
- 类型(Type):用于描述此次提交的类型,建议采用以下几种类型分类:
- feat:新功能(feature)
- fix:修复bug
- docs:文档(documentation)
- style:格式修改(如:空格、样式、缺少分号等,代码未改变)
- refactor:重构(既不是新增功能也不是修改bug的代码变动)
- test:添加、修改测试代码
- chore:工具链变动、库的初始化等
- 范围(Scope):用于描述此次提交影响的范围,建议具体化。
- 描述信息(Subject):用于简要描述此次提交的内容,建议不超过50个字符。
- 体验改进或破坏性(Experiences or Breaking Change):可选,用于说明此次提交是否对用户体验造成影响,或者是否破坏了之前的代码。
- 详细信息(Body):用于详细描述此次提交的内容,可以包含任何相关的信息,但是建议不超过72个字符,换行也要分段。
3、提交文件:
每一次提交应该包含尽可能少的文件,建议使用 git add [file],而非 git add .,这样可以保证每次提交都是有意义的。
以上则是 Git 提交规范的一些常规约束,按照 Git 提交规范提交可以使提交信息更加清晰明了,有助于代码维护和管理。