文字规范

commit一共由五部分组成，具体内容如下。

type

提交 commit 的类型，包括以下几种

  • feat: 新功能
  • fix: 修复问题
  • docs: 修改文档
  • style: 修改代码格式，不影响代码逻辑
  • refactor: 重构代码，理论上不影响现有功能
  • perf: 提升性能
  • test: 增加修改测试用例
  • chore: 修改工具相关（包括但不限于文档、代码生成等）
  • deps: 升级依赖

scope

修改文件的范围（包括但不限于 doc, middleware, core, config, plugin）

subject

用一句话清楚的描述这次提交做了什么

body

补充 subject，适当增加原因、目的等相关因素，也可不写。

  • 当有非兼容修改(Breaking Change)时必须在这里描述清楚
  • 关联相关 issue，如 Closes #1, Closes #2, #3
  • 如果功能点有新增或修改的，还需要关联文档 doc

emoji规范

emoji emoji代码 commit说明
🎨 (调色板) 🎨 改进代码结构/代码格式
⚡️ (闪电) ⚡ 提升性能
🐎 (赛马) 🐎 提升性能
🔥 (火焰) 🔥 移除代码或文件
🐛 (bug) 🐛 修复 bug
🚑 (急救车) 🚑 重要补丁
✨ (火花) ✨ 引入新功能
📝 (铅笔) 📝 撰写文档
🚀 (火箭) 🚀 部署功能
💄 (口红) 💄 更新 UI 和样式文件
🎉 (庆祝) 🎉 初次提交
✅ (白色复选框) ✅ 增加测试
🔒 (锁) 🔒 修复安全问题
🍎 (苹果) 🍎 修复 macOS 下的问题
🐧 (企鹅) 🐧 修复 Linux 下的问题
🏁 (旗帜) :checked_flag: 修复 Windows 下的问题
🔖 (书签) 🔖 发行/版本标签
🚨 (警车灯) 🚨 移除 linter 警告
🚧 (施工) 🚧 工作进行中
💚 (绿心) 💚 修复 CI 构建问题
⬇️ (下降箭头) ⬇ 降级依赖
⬆️ (上升箭头) ⬆ 升级依赖
👷 (工人) 👷 添加 CI 构建系统
📈 (上升趋势图) 📈 添加分析或跟踪代码
🔨 (锤子) 🔨 重大重构
➖ (减号) ➖ 减少一个依赖
🐳 (鲸鱼) 🐳 相关工作
➕ (加号) ➕ 增加一个依赖
🔧 (扳手) 🔧 修改配置文件
🌐 (地球) 🌐 国际化与本地化
✏️ (铅笔) ✏ 修复 typo

git提交插件