一直以来个人提交git都是做了啥直接写啥，虽然尽可能的写得很详细但是时间一久难免忘记当时到底是做什么功能。受到同事的提醒，他将他使用的git提交规范推荐给了我，使用了一段时间后感觉确实工作内容看起来更加清晰了，虽然只是几个简单规范，但是受益匪浅。

git 提交规范

为什么要制定提交规范？

  • 便于程序员对提交历史进行追溯，了解发生了什么情况。
  • 一旦约束了 Commit Message ，意味着我们将慎重的进行每一次提交，不能再一股脑的把各种各样的改动都放在一个git commit里面，这样一来整个代码改动的历史也将更加清晰。
  • 格式化的 Commit Message 才可以用于自动化输出 Change log 。

业界通用的Git提交规范：

1
<type>(<scope>):<subject>
  • type: 用于说明 Git Commit 的类别，只允许使用下面的标识。
  • scope: scope用于说明 Commit 影响的范围，比如数据层、控制层、视图层等，视项目不同而不同。
  • subject: subject是 Commit 目的的简短描述，一般不超过50个字符。

这里简单记录一下基本的提交规范：

类型 emji 描述
feat ✨ 引入新功能
fix 🐛 修复 bug
style 💄 更新 UI 样式文按键
format 🥚 格式化代码
docs 📝 添加/更新文档
perf 👌 提高性能/优化
init 🎉 初次提交/初始化项目
test ✅ 增加测试代码
refactor 🎨 改进代码结构/代码格式
patch 🚑 添加重要补丁
file 📦 添加新文件
publish 🚀 发布新版本
tag 📌 发布新版本
config 🔧 修改配置文件
git 🙈 添加或修改.gitignore 文件

更加详细的规范可以参考这个： https://developer.aliyun.com/article/441408

如果懒的话可以使用插件帮助，在vscode上提供很多辅助插件，比如 git-commit-lint-vscode