git 提交信息规范
您可以遵循的Git commit消息约定!
典型的git commit消息像下面这样
1 | <type>(<scope>): <subject> |
“类型”必须是以下提到的以下内容之一!
- build: 建立相关的更改(例如:与npm相关/添加外部依赖项)
- chore: 外部用户看不到的代码更改(例如:更改为.gitignore文件或.prettierrc文件)
- feat: 新特性
- fix: bug修复
- docs: 与文档相关的改变
- refactor: 既不修复错误也不添加功能的代码。 (例如:您可以在语义更改(例如重命名变量/函数名称)时使用此功能)
- perf: 可以提高性能的代码
- style: 有关样式的代码
- test: 添加新测试或对现有测试进行更改
- update: 更新
- upgrade: 升级
- sponsors: 赞助相关
“scope” 是可选的
- scope 必须是名词,并且代表代码库部分的部分
- 请参阅此链接以获取与scope相关的示例
“subject”
- 使用命令式,现在时(如: 使用”add” 代替 “added” 或 “adds”)
- 不要使用 “.” 结尾
- 不要使用首字母大写方式