-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
📝 Commit Message Guide with Emojis (#1944)
- Loading branch information
1 parent
d911f33
commit ff6a1ca
Showing
4 changed files
with
132 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| # Commit Message Guide with Emojis | ||
|
|
||
| Using emoji prefixes to mark commit messages is a popular practice that makes commit messages more intuitive, concise, and easy to search. Below is the list of emojis used in the project: | ||
|
|
||
| | Emoji | Emoji Code | Commit Description | | ||
| | :--------------------------------------- | :---------------------------- | :---------------------------------------------------- | | ||
| | :art: | `:art:` | Improve code structure/format | | ||
| | :zap:<br>:racehorse: | `:zap:`<br>`:racehorse:` | Improve performance | | ||
| | :fire: | `:fire:` | Remove code or files | | ||
| | :bug: | `:bug:` | Fix a bug | | ||
| | :ambulance: | `:ambulance:` | Critical hotfix | | ||
| | :sparkles: | `:sparkles:` | Introduce new features | | ||
| | :memo: | `:memo:` | Write documentation | | ||
| | :rocket: | `:rocket:` | Deploy features | | ||
| | :lipstick: | `:lipstick:` | Update UI and style files | | ||
| | :tada: | `:tada:` | Initial commit | | ||
| | :white_check_mark: | `:white_check_mark:` | Add tests | | ||
| | :lock: | `:lock:` | Fix security issues | | ||
| | :apple: | `:apple:` | Fix macOS-specific content | | ||
| | :penguin: | `:penguin:` | Fix Linux-specific content | | ||
| | :checkered_flag: | `:checked_flag:` | Fix Windows-specific content | | ||
| | :robot: | `:robot:` | Fix Android-specific content | | ||
| | :green_apple: | `:green_apple:` | Fix iOS-specific issues | | ||
| | :bookmark: | `:bookmark:` | Release/Version tags | | ||
| | :rotating_light: | `:rotating_light:` | Remove linter warnings | | ||
| | :construction: | `:construction:` | Work in progress | | ||
| | :green_heart: | `:green_heart:` | Fix CI build issues | | ||
| | :arrow_down: | `:arrow_down:` | Downgrade dependencies | | ||
| | :arrow_up: | `:arrow_up:` | Upgrade dependencies | | ||
| | :pushpin: | `:pushpin:` | Pin dependencies to specific versions | | ||
| | :construction_worker: | `:construction_worker:` | Add CI build system | | ||
| | :chart_with_upwards_trend: | `:chart_with_upwards_trend:` | Add analytics or tracking code | | ||
| | :recycle: | `:recycle:` | Refactor code | | ||
| | :hammer: | `:hammer:` | Major refactoring | | ||
| | :heavy_minus_sign: | `:heavy_minus_sign:` | Remove a dependency | | ||
| | :whale: | `:whale:` | Docker-related work | | ||
| | :heavy_plus_sign: | `:heavy_plus_sign:` | Add a dependency | | ||
| | :wrench: | `:wrench:` | Modify configuration files | | ||
| | :globe_with_meridians: | `:globe_with_meridians:` | Internationalization and localization | | ||
| | :pencil2: | `:pencil2:` | Fix typos | | ||
| | :hankey: | `:hankey:` | Write bad code that needs improvement | | ||
| | :rewind: | `:rewind:` | Revert changes | | ||
| | :twisted_rightwards_arrows: | `:twisted_rightwards_arrows:` | Merge branches | | ||
| | :package: | `:package:` | Update compiled files or packages | | ||
| | :alien: | `:alien:` | Update code due to external API changes | | ||
| | :truck: | `:truck:` | Move or rename files | | ||
| | :page_facing_up: | `:page_facing_up:` | Add or update license | | ||
| | :boom: | `:boom:` | Introduce breaking changes | | ||
| | :bento: | `:bento:` | Add or update assets | | ||
| | :ok_hand: | `:ok_hand:` | Update code due to code review changes | | ||
| | :wheelchair: | `:wheelchair:` | Improve accessibility | | ||
| | :bulb: | `:bulb:` | Document source code | | ||
| | :beers: | `:beers:` | Write code drunkenly | | ||
| | :speech_balloon: | `:speech_balloon:` | Update text and literals | | ||
| | :card_file_box: | `:card_file_box:` | Perform database-related changes | | ||
| | :loud_sound: | `:loud_sound:` | Add logs | | ||
| | :mute: | `:mute:` | Remove logs | | ||
| | :busts_in_silhouette: | `:busts_in_silhouette:` | Add contributors | | ||
| | :children_crossing: | `:children_crossing:` | Improve user experience/usability | | ||
| | :building_construction: | `:building_construction:` | Make architectural changes | | ||
| | :iphone: | `:iphone:` | Work on responsive design | | ||
| | :clown_face: | `:clown_face:` | Mock things | | ||
| | :egg: | `:egg:` | Add an easter egg | | ||
| | :see_no_evil: | `:see_no_evil:` | Add or update .gitignore file | | ||
| | :camera_flash: | `:camera_flash:` | Add or update snapshots | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| # 提交信息 Emoji 规范 | ||
|
|
||
| 使用 emoji 前缀标记提交信息是一种流行的做法，它可以让提交信息更加直观、简洁、易于搜索。下面是项目使用的 emoji 列表： | ||
|
|
||
| | emoji 表情 | emoji 代码 | commit 说明 | | ||
| |:------------------------------------|:------------------------------| :--------------------------- | | ||
| | :art: (调色板) | `:art:` | 改进代码结构/代码格式 | | ||
| | :zap: (闪电) | `:zap:` | 提升性能 | | ||
| | :fire: (火焰) | `:fire:` | 移除代码或文件 | | ||
| | :bug: (bug) | `:bug:` | 修复 bug | | ||
| | :ambulance: (急救车) | `:ambulance:` | 重要补丁 | | ||
| | :sparkles: (火花) | `:sparkles:` | 引入新功能 | | ||
| | :memo: (备忘录) | `:memo:` | 撰写文档 | | ||
| | :rocket: (火箭) | `:rocket:` | 部署功能 | | ||
| | :lipstick: (口红) | `:lipstick:` | 更新 UI 和样式文件 | | ||
| | :tada: (庆祝) | `:tada:` | 初次提交 | | ||
| | :white_check_mark: (白色复选框) | `:white_check_mark:` | 增加测试 | | ||
| | :lock: (锁) | `:lock:` | 修复安全问题 | | ||
| | :apple: (苹果) | `:apple:` | 修复 macOS 下的内容 | | ||
| | :penguin: (企鹅) | `:penguin:` | 修复 Linux 下的内容 | | ||
| | :checkered_flag: (旗帜) | `:checked_flag:` | 修复 Windows 下的内容 | | ||
| | :robot: (Android机器人) | `:robot:` | 修复Android上的某些内容。 | | ||
| | :green_apple: (绿苹果) | `:green_apple:` | 解决iOS上的某些问题。 | | ||
| | :bookmark: (书签) | `:bookmark:` | 发行/版本标签 | | ||
| | :rotating_light: (警车灯) | `:rotating_light:` | 移除 linter 警告 | | ||
| | :construction: (施工) | `:construction:` | 工作进行中 | | ||
| | :green_heart: (绿心) | `:green_heart:` | 修复 CI 构建问题 | | ||
| | :arrow_down: (下降箭头) | `:arrow_down:` | 降级依赖 | | ||
| | :arrow_up: (上升箭头) | `:arrow_up:` | 升级依赖 | | ||
| | :pushpin: (图钉) | `:pushpin:` | 将依赖关系固定到特定版本。 | | ||
| | :construction_worker: (工人) | `:construction_worker:` | 添加 CI 构建系统 | | ||
| | :chart_with_upwards_trend: (上升趋势图) | `:chart_with_upwards_trend:` | 添加分析或跟踪代码 | | ||
| | :recycle: (循环箭头) | `:recycle:` | 重构代码。 | | ||
| | :hammer: (锤子) | `:hammer:` | 重大重构 | | ||
| | :heavy_minus_sign: (减号) | `:heavy_minus_sign:` | 减少一个依赖 | | ||
| | :whale: (鲸鱼) | `:whale:` | Docker 相关工作 | | ||
| | :heavy_plus_sign: (加号) | `:heavy_plus_sign:` | 增加一个依赖 | | ||
| | :wrench: (扳手) | `:wrench:` | 修改配置文件 | | ||
| | :globe_with_meridians: (地球) | `:globe_with_meridians:` | 国际化与本地化 | | ||
| | :pencil2: (铅笔) | `:pencil2:` | 修复 typo | | ||
| | :hankey: (瞪眼) | `:hankey:` | 编写需要改进的错误代码。 | | ||
| | :rewind: (双左箭头) | `:rewind:` | 恢复更改。 | | ||
| | :twisted_rightwards_arrows: (双合并箭头) | `:twisted_rightwards_arrows:` | 合并分支。 | | ||
| | :package: (箱子) | `:package:` | 更新编译的文件或包。 | | ||
| | :alien: (面具) | `:alien:` | 由于外部API更改而更新代码。 | | ||
| | :truck: (面包车) | `:truck:` | 移动或重命名文件。 | | ||
| | :page_facing_up: (文档) | `:page_facing_up:` | 添加或更新许可证。 | | ||
| | :boom: (爆炸) | `:boom:` | 介绍突破性变化。 | | ||
| | :bento: (装满餐盘) | `:bento:` | 添加或更新资产。 | | ||
| | :ok_hand: (OK手势) | `:ok_hand:` | 由于代码审查更改而更新代码。 | | ||
| | :wheelchair: (坐姿) | `:wheelchair:` | 提高可访问性。 | | ||
| | :bulb: (灯泡) | `:bulb:` | 记录源代码。 | | ||
| | :beers: (干杯) | `:beers:` | 醉生梦死的写代码。 | | ||
| | :speech_balloon: (提示栏) | `:speech_balloon:` | 更新文字和文字。 | | ||
| | :card_file_box: (卡片盒子) | `:card_file_box:` | 执行与数据库相关的更改。 | | ||
| | :loud_sound: (有声喇叭) | `:loud_sound:` | 添加日志。 | | ||
| | :mute: (静音喇叭) | `:mute:` | 删除日志。 | | ||
| | :busts_in_silhouette: (两个人头) | `:busts_in_silhouette:` | 添加贡献者。 | | ||
| | :children_crossing: (小盆友) | `:children_crossing:` | 改善用户体验/可用性。 | | ||
| | :building_construction: (吊车) | `:building_construction:` | 进行架构更改。 | | ||
| | :iphone: (手机) | `:iphone:` | 致力于响应式设计。 | | ||
| | :clown_face: (小丑) | `:clown_face:` | 嘲笑事物。 | | ||
| | :egg: (彩蛋) | `:egg:` | 添加一个复活节彩蛋。 | | ||
| | :see_no_evil: (蒙眼猴子) | `:see_no_evil:` | 添加或更新.gitignore文件。 | | ||
| | :camera_flash: (照相机) | `:camera_flash:` | 添加或更新快照。 | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters