示例
以下是一个 Git 规范提交的示例:
feat: 添加了新的用户注册功能。
fix: 修复了登录流程中的 Bug。
refactor: 重构了订单处理模块,提高了性能。
docs: 更新了用户指南中的部分内容。
style: 统一了代码中的缩进风格。
在这个示例中,使用了一些常见的提交类型关键词,如feat
(功能添加)、fix
(Bug 修复)、refactor
(重构)、docs
(文档更新)和style
(代码风格改进)。每个提交消息都简洁地描述了所做的具体变更。这样的规范提交有助于其他开发者快速了解代码的变化和目的。你可以根据项目的需求和团队的约定来定义自己的提交类型和消息格式。
Git Foramt
作用域(scope)表示此次提交影响的范围。比如可以取值api,表明只影响了接口。
主题(subject)描述是简短的一句话,简单说明此次提交的内容
<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>
下面给出了一个Commit Message例子,该例子中包含了header和body。
chore: 引入commitizen
BREANKING CHANGE:需要重新npm install,使用npm run cm代替git commit
比如我们修改了登录页面的某个功能,那么可以这样写 Commit Message。
feat(登录):添加登录接口
Git Type
类型 | 描述 |
feat | 新功能(feature) |
fix | 修复bug |
doc | 文档(documentation) |
style | 格式化 ESLint调整等(不影响代码运行的变动) |
refactor | 重构(即不是新增功能,也不是修改bug的代码变动) |
test | 增加测试 |
build | 影响构建系统或外部依赖项的更改(maven,gradle,npm等等) |
ci | 对CI配置文件和脚本的更改 |
chore | 对非 src 和 test 目录的修改 |
revert | Revert a commit |
perf | 优化相关,如提升性能、优化算法等 |
security | 与安全相关的改动,如修复安全漏洞、增强安全性等 |
deps | 更新依赖库版本 |
merge | 合并分支时的提交 |
release | 发布新版本 |
vendor | 更新第三方库或依赖 |
config | 更改配置文件 |
i18n | 国际化与本地化相关的改动 |
data | 数据相关的改动,如数据库模式更新、种子数据等 |
styleguide | 样式指南相关的改动,如修改缩进、空格、注释等 |
license | 更新或添加许可证文件 |
analytics | 添加或更新分析或跟踪代码 |
init | 初始化 |
setup | 设置 |
Emoji
Emoji | 代码 | Commit 说明 |
🎨 | art | 改进代码结构/代码格式 |
⚡️ 🐎 | zap racehorse | 提升性能 |
🔥 | fire | 移除代码或文件 |
🐛 | bug | 修复 bug |
🚑 | ambulance | 重要补丁 |
✨ | sparkles | 引入新功能 |
📝 | memo | 撰写文档 |
🚀 | rocket | 部署功能 |
💄 | lipstick | 更新 UI 和样式文件 |
🎉 | tada | 初次提交 |
✅ | white_check_mark | 更新测试 |
🔒 | lock | 修复安全问题 |
🍎 | apple | 修复 macOS 下的问题 |
🐧 | penguin | 修复 Linux 下的问题 |
🏁 | checked_flag | 修复 Windows 下的问题(这个不会显示,慎用) |
🤖 | robot | 修复 Android 下的问题 |
🍏 | green_apple | 修复 iOS 下的问题 |
🔖 | bookmark | 发行/版本标签 |
🚨 | rotating_light | 移除 linter 警告 |
🚧 | construction | 工作进行中 |
👷 | construction_worker | 添加 CI 构建系统 |
💚 | green_heart | 修复 CI 构建问题 |
⬆️ | arrow_up | 升级依赖 |
⬇️ | arrow_down | 降级依赖 |
📌 | pushpin | 将依赖项固定到特定版本 |
📈 | chart_with_upwards_trend | 添加分析或跟踪代码 |
♻️ | recycle | 重构代码 |
🐳 | whale | Docker 相关工作 |
🌐 | globe_with_meridians | 国际化与本地化 |
➕ | heavy_plus_sign | 增加一个依赖 |
➖ | heavy_minus_sign | 减少一个依赖 |
🔧 | wrench | 修改配置文件 |
🔨 | hammer | 重大重构 |
✏️ | pencil2 | 修复 typo |
💩 | hankey | 写了辣鸡代码需要优化 |
⏪ | rewind | 恢复更改 |
🔀 | twisted_rightwards_arrows | 合并分支 |
📦 | package | 更新编译的文件或包 |
👽 | alien | 由于外部API更改而更新代码 |
🚚 | truck | 移动或者重命名文件 |
📄 | page_facing_up | 增加或更新许可证书 |
💥 | boom | 引入突破性的变化 |
🍱 | bento | 增加或更新资源 |
👌 | ok_hand | 由于代码审查更改而更新代码 |
♿️ | wheelchair | 改善无障碍交互 |
💡 | bulb | 给代码添加注释 |
🍻 | beers | 醉醺醺地写代码 |
💬 | speech_balloon | 更新文本文档 |
🗃 | card_file_box | 执行与数据库相关的更改 |
🔊 | loud_sound | 增加日志 |
🔇 | mute | 移除日志 |
👥 | busts_in_silhouette | 增加贡献者 |
🚸 | children_crossing | 优化用户体验、可用性 |
🏗 | building_construction | 结构变动 |
📱 | iphone | 做响应式设计 |
🤡 | clown_face | 嘲弄事物 |
🥚 | egg | 增加彩蛋 |
🙈 | see_no_evil | 增加或更改 gitignore |
📸 | camera_with_flash | 增加或更新截图 |
⚗️ | alembic | 尝试新东西 |
🔍 | mag | SEO 优化 |
☸️ | wheel_of_dharma | 关于 Kubernetes 的工作 |
🏷 | label | 增加类型(Flow、Typescript) |
若有收获,就点个赞吧