Git Commit emoji Guide
背景
gitmoji 是一个标准化和解释在 GitHub 提交消息上使用 emoji 的提议,gitmoji 是一个开源项目,专门规定了在 ``github 提交代码是应当遵循的 emoji 规范。在 git commit上使用 emoji 提供了一种简单的方法,仅通过查看所使用的表情符号来确定提交的目的或意图
概述
在执行 git commit 指令时使用 emoji 图标为本次提交一个特别的图标,这个本次提交的记录很容易突出重点,也可以光看图标就知道本次提交的目的。这样方便在日后查看历史提交日子记录中快速查看到对应的提交版本。由于有很多不同的表情符号,表情库更新后没有一个可以帮助更轻松地使用表情符号的中文表情库列表,所以这里列出 gitmoji 项目中规定的 emoji 规范的表情符号列表
gitmoji 表情库
emoji 表情 | emoji 代码 | commit 说明 |
---|
🎨 (调色板) | :art: | 改进代码结构/代码格式 | ?? (闪电) 🐎 (赛马) | :zap: :racehorse: | 提升性能 | 🔥 (火焰) | :fire: | 移除代码或文件 | 🐛 (bug) | :bug: | 修复 bug | 🚑 (急救车) | :ambulance: | 重要补丁 | ? (火花) | :sparkles: | 引入新功能 | 📝 (备忘录) | :memo: | 撰写文档 | 🚀 (火箭) | :rocket: | 部署功能 | 💄 (口红) | :lipstick: | 更新 UI 和样式文件 | 🎉 (庆祝) | :tada: | 初次提交 | ? (白色复选框) | :white_check_mark: | 增加测试 | 🔒 (锁) | :lock: | 修复安全问题 | 🍎 (苹果) | :apple: | 修复 macOS 下的内容 | 🐧 (企鹅) | :penguin: | 修复 Linux 下的内容 | 🏁 (旗帜) | :checked_flag: | 修复 Windows 下的内容 | 🤖 (Android机器人) | :robot: | 修复Android上的某些内容。 | 🍏 (绿苹果) | :green_apple: | 解决iOS上的某些问题。 | 🔖 (书签) | :bookmark: | 发行/版本标签 | 🚨 (警车灯) | :rotating_light: | 移除 linter 警告 | 🚧 (施工) | :construction: | 工作进行中 | 💚 (绿心) | :green_heart: | 修复 CI 构建问题 | ?? (下降箭头) | :arrow_down: | 降级依赖 | ?? (上升箭头) | :arrow_up: | 升级依赖 | 📌 (图钉) | :pushpin: | 将依赖关系固定到特定版本。 | 👷 (工人) | :construction_worker: | 添加 CI 构建系统 | 📈 (上升趋势图) | :chart_with_upwards_trend: | 添加分析或跟踪代码 | ?? (循环箭头) | :recycle: | 重构代码。 | 🔨 (锤子) | :hammer: | 重大重构 | ? (减号) | :heavy_minus_sign: | 减少一个依赖 | 🐳 (鲸鱼) | :whale: | Docker 相关工作 | ? (加号) | :heavy_plus_sign: | 增加一个依赖 | 🔧 (扳手) | :wrench: | 修改配置文件 | 🌐 (地球) | :globe_with_meridians: | 国际化与本地化 | ?? (铅笔) | :pencil2: | 修复 typo | 💩 (瞪眼) | :hankey: | 编写需要改进的错误代码。 | ? (双左箭头) | :rewind: | 恢复更改。 | 🔀 (双合并箭头) | :twisted_rightwards_arrows: | 合并分支。 | 📦 (箱子) | :package: | 更新编译的文件或包。 | 👽 (面具) | :alien: | 由于外部API更改而更新代码。 | 🚚 (面包车) | :truck: | 移动或重命名文件。 | 📄 (文档) | :page_facing_up: | 添加或更新许可证。 | 💥 (爆炸) | :boom: | 介绍突破性变化。 | 🍱 (装满餐盘) | :bento: | 添加或更新资产。 | 👌 (OK手势) | :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_flash: | 添加或更新快照。 |
gitmoji-cli
需要使用 npm 安装
npm i -g gitmoji-cli
使用
$ gitmoji --help
A gitmoji interactive client for using gitmojis on commit messages.
Usage
$ gitmoji
Options
--init, -i Initialize gitmoji as a commit hook
--remove, -r Remove a previously initialized commit hook
--config, -g Setup gitmoji-cli preferences.
--commit, -c Interactively commit using the prompts
--list, -l List all the available gitmojis
--search, -s Search gitmojis
--version, -v Print gitmoji-cli installed version
--update, -u Sync emoji list with the repo
-
在本地 git repo 中 使用 gitmoji -i 初始化 -
按照正常 git 操作提交代码 git add .
git commit "feat: update"
-
git commit 回车之后会自动触发 gitmoji hook,按照提示操作即可 ? xxxx git:(feature/issue-#287) ? git commit -m "feat: update status"
? Choose a gitmoji: ? - Introduce new features.
? Enter the commit title [31/48]: feat: update status
? Enter the commit message:
[feature/issue-#287 a75cf85b] :sparkles: feat: update status
3 files changed, 53 insertions(+), 2 deletions(-)
-
如果该仓库不想继续使用 gitmoji 使用 gitmoji -r 即可移除 gitmoji
参考:[gitmoji 仓库地址](
|