Commit message 都包括三个部分:header,body 和 footer,其中 header 有一个特殊的格式,包括了 type、scope、subject。
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
header 部分规范其实基本能满足绝大部分需要
type(*)
commit 的类型:
feat: 新功能、新特性
fix: 修改 bug
perf: 更改代码,以提高性能(在不影响代码内部行为的前提下,对程序性能进行优化)
refactor: 代码重构(重构,在不影响代码内部行为、功能下的代码修改)
docs: 文档修改
style: 代码格式修改, 注意不是 css 修改(例如分号修改)
test: 测试用例新增、修改
build: 影响项目构建或依赖项修改
revert: 恢复上一次提交
ci: 持续集成相关文件修改
chore: 其他修改(不在上述类型中的修改)
release: 发布新版本
workflow: 工作流相关文件修改
scope(*)
commit 影响的范围, 比如: route, component, utils, build...
subject(*)
commit 的概述
emoji 表情库(选填)
/*
emoji emoji 代码 commit 说明
feat ✨ :new: 引入新功能
fix :bug: 修复 bug
style :lipstick: 更新 UI 样式文按键
format :art: 格式化代码
docs :memo:/:book: 添加/更新文档
perf :zap:/:racehorse: 提高性能/优化
init 初次提交/初始化项目
test ✅ 增加测试代码
refactor 改进代码结构/代码格式
patch 添加重要补丁
file 添加新文件
publish 发布新版本
tag 发布新版本
config 修改配置文件
git 添加或修改.gitignore 文件
chore ⚡ 改变构建流程、或者增加依赖库、工具等
delete :fire: 删除文件
*/
emoji emoji 代码 commit 说明
(庆祝) :tada : 初次提交
(全新) :new : 引入新功能
(书签) :bookmark : 发行/版本标签
(bug) :bug : 修复 bug
(急救车) :ambulance : 重要补丁
(地球) :globe_with_meridians : 国际化与本地化
(口红) :lipstick : 更新 UI 和样式文件
(场记板) :clapper : 更新演示/示例
(警车灯) :rotating_light : 移除 linter 警告
(扳手) :wrench : 修改配置文件
➕ (加号) :heavy_plus_sign : 增加一个依赖
➖ (减号) :heavy_minus_sign : 减少一个依赖
⬆️ (上升箭头) :arrow_up : 升级依赖
⬇️ (下降箭头) :arrow_down : 降级依赖
⚡️ (闪电) :zap : 提升性能
(赛马) :racehorse : 提升性能
(上升趋势图) :chart_with_upwards_trend : 添加分析或跟踪代码
(火箭) :rocket : 部署功能
✅ (白色复选框) :white_check_mark : 增加测试
(备忘录) :memo : 撰写文档
(书) :book : 撰写文档
(锤子) :hammer : 重大重构
(调色板) :art : 改进代码结构/代码格式
(火焰) :fire : 移除代码或文件
(施工) :construction : 工作进行中
(垃圾桶) :wastebasket : 废弃或删除
(工人) :construction_worker : 添加 CI 构建系统
(绿心) :green_heart : 修复 CI 构建问题
(锁) :lock : 修复安全问题
(鲸鱼) :whale : Docker 相关工作
(苹果) :apple : 修复 macOS 下的问题
(企鹅) :penguin : 修复 Linux 下的问题
(旗帜) :checkered_flag : 修复 Windows 下的问题
(交叉箭头) :twisted_rightwards_arrows : 分支合并