git 提交规范
commit message 格式 :
<type>(<scope>): <subject>
- 一、type(必须): 用于说明git commit的类别,只允许使用下面的标识。
- fix/to:修复bug,可以是QA发现的BUG,也可以是研发自己发现的BUG。
fix:产生diff并自动修复此问题。适合于一次提交直接修复问题
to:只产生diff不自动修复此问题。适合于多次提交。最终修复问题提交时使用fix- docs:文档(documentation)。
- style:格式(不影响代码运行的变动)。
- refactor:重构(即不是新增功能,也不是修改bug的代码变动)。
- perf:优化相关,比如提升性能、体验。
- test:增加测试。
- chore:构建过程或辅助工具的变动。
- revert:回滚到上一个版本,还原。
- merge:代码合并。
- sync:同步主线或分支的Bug。
- feat:新功能(feature)
- ci 持续集成
- types 类型定义文件更改
- wip 开发中
- release 发布新版本
- 二、scope(可选): scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。
例如在Angular,可以是location,browser,compile,compile,rootScope, ngHref,ngClick,ngView等。如果你的修改影响了不止一个scope,你可以使用*代替。
- 三、subject(必须): subject是commit目的的简短描述,不超过50个字符。
建议使用中文(感觉中国人用中文描述问题能更清楚一些)。
结尾不加句号或其他标点符号。
根据以上规范git commit message将是如下的格式:
fix(DAO):用户查询缺少username属性
feat(Controller):用户查询接口开发
表情
表情 | 代码 | 代表内容 |
---|---|---|
✨ | :sparkles: | 添加新功能 |
🐛 | :bug: | 修复bug |
💄 | :lipstick: | 优化UI和样式文件 |
🎨 | :art: | 优化代码结构或格式 |
🔀 | :twisted_rightwards_arrows: | 合并分支 |
🚧 | :construction: | 未完工程 |
⚡️ | :zap: | 提升性能 |
🔥 | :fire: | 移除代码或文件 |
🚑 | :ambulance: | 修复关键程序 |
📝 | :memo: | 写文档 |
🚀 | :rocket: | 部署项目 |
🎉 | :tada: | 初始提交 |
✅ | :white_check_mark: | 添加测试 |
🔒 | :lock: | 解决安全问题 |
🔖 | :bookmark: | 发布/版本标签 |
🚨 | :rotating_light: | 删除linter警告 |
💚 | :green_heart: | 修复CI构建 |
⬇️ | arrow_down: | 降级依赖 |
⬆️ | :arrow_up: | 升级依赖 |
👷 | :construction_worker: | 添加CI构建系统 |
📈 | :chart_with_upwards_trend: | 添加分析或跟踪代码 |
🔨 | :hammer: | 重构代码 |
➖ | :heavy_minus_sign: | 删除依赖 |
✏️ | :pencil2: | 修正错别字 |
💩 | :hankey: | 编写需要改进的不好的代码 |
⏪ | :rewind: | 恢复更改 |
📦 | :package: | 更新编译的文件或包 |
👽 | :alien: | 由于外部API更改而更新代码 |
🚚 | :truck: | 移动或重命名文件 |
📄 | :page_facing_up: | 添加或更新许可证 |
💥 | :boom: | 介绍突破性变化 |
🍱 | :bento: | 添加或更新静态资源 |
👌 | :ok_hand: | 由于代码审阅更改而更新代码 |
💡 | :bulb: | 记录源代码 |
💬 | :speech_balloon: | 更新文本或字面量 |
🔊 | :loud_sound: | 添加日志 |
👥 | :busts_in_silhouette: | 添加贡献者 |
🚸 | :children_crossing: | 改善用户体验/可用性 |