您可以遵循的 Git 提交消息约定!
这个博客的目的是将所有信息集中在一个地方,并让更多的人了解行业遵循的标准。
让我们开始吧.....
典型的 git 提交信息如下
<type>(<scope>): <subject>
“类型”必须是下面提到的之一!
build
:构建相关更改(例如:npm 相关/添加外部依赖项)chore
:外部用户看不到的代码更改(例如:更改为 .gitignore 文件或 .prettierrc 文件)feat
:新功能fix
:错误修复docs
:文档相关变更refactor
:既不修复错误也不添加功能的代码。(例如:当有语义变化(如重命名变量/函数名称)时可以使用此功能)perf
:提高性能的代码style
:与样式相关的代码test
:添加新测试或更改现有测试
“范围”是可选的
- 范围必须是名词,它代表代码库部分的部分
- 有关范围的示例,请参阅此链接
“主题”
- 使用祈使句、现在时(例如:使用“add”而不是“added”或“adds”)
- 不要在末尾使用点(.)
- 不要将首字母大写
参考:
- https://www.conventionalcommits.org/en/v1.0.0/
- https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716
- https://github.com/fteem/git-semantic-commits