# git commit emoji 使用指南
# 目录
执行 git commit 时使用 emoji 为本次提交打上一个 "标签", 使得此次 commit 的主要工作得以凸现，也能够使得其在整个提交历史中易于区分与查找。
截取的 gitmoji (opens new window) 快照:
# commit 格式
git commit 时，提交信息遵循以下格式：
:emoji1: :emoji2: 不超过 50 个字的摘要，首字母大写，使用祈使语气，句末不要加句号
提交信息主体
引用相关 issue 或 PR 编号 <#110>
初次提交示例：
git commit -m ":tada: Initialize Repo"
# emoji 指南
| emoji | emoji 代码 | commit 说明 |
|---|---|---|
| 🎉 (庆祝) | tada | 初次提交 |
| ✨ (火花) | sparkles | 引入新功能 |
| 🔖 (书签) | bookmark | 发行/版本标签 |
| 🐛 (bug) | bug | 修复 bug |
| 🚑 (急救车) | ambulance | 重要补丁 |
| 🌐 (地球) | globe_with_meridians | 国际化与本地化 |
| 💄 (口红) | lipstick | 更新 UI 和样式文件 |
| 🚨 (警车灯) | rotating_light | 移除 linter 警告 |
| 🔧 (扳手) | wrench | 修改配置文件 |
| ➕ (加号) | heavy_plus_sign | 增加一个依赖 |
| ➖ (减号) | heavy_minus_sign: | 减少一个依赖 |
| ⬆️ (上升箭头) | arrow_up | 升级依赖 |
| ⬇️ (下降箭头) | arrow_down | 降级依赖 |
| ⚡️ (闪电) 🐎 (赛马) | zapracehorse | 提升性能 |
| 📈 (上升趋势图) | chart_with_upwards_trend | 添加分析或跟踪代码 |
| 🚀 (火箭) | rocket | 部署功能 |
| ✅ (白色复选框) | white_check_mark | 增加测试 |
| 📝 (备忘录) | memo | 撰写文档 |
| 🔨 (锤子) | hammer | 重大重构 |
| 🎨 (调色板) | art | 改进代码结构/代码格式 |
| 🔥 (火焰) | fire | 移除代码或文件 |
| ✏️ (铅笔) | pencil2 | 修复 typo |
| 🚧 (施工) | construction | 工作进行中 |
| 👷 (工人) | construction_worker | 添加 CI 构建系统 |
| 💚 (绿心) | green_heart | 修复 CI 构建问题 |
| 🔒 (锁) | lock | 修复安全问题 |
| 🐳 (鲸鱼) | whale | Docker 相关工作 |
| 🍎 (苹果) | apple | 修复 macOS 下的问题 |
| 🐧 (企鹅) | penguin | 修复 Linux 下的问题 |
| 🏁 (旗帜) | checkered_flag | 修复 Windows 下的问题 |
- 需要用
::包裹住 emoji 代码
# 如何在命令行中显示 emoji
默认情况下，在命令行中并不会显示出 emoji, 仅显示 emoji 代码。不过可以使用 emojify (opens new window) 使得在命令行也可显示 emoji, 它是一个 shell 脚本，安装与使用都很简单，在 这里 (opens new window) 查看如何安装与使用。
# 参考
# git commit emoji
- gitmoji (opens new window)
- emoji-cheat-sheet (opens new window)
- styleguide-git-commit-message (opens new window)
- atom git commit messages guide (opens new window)
- An emoji guide for your commit messages (opens new window)
- 程序员提交代码的 emoji 指南——原来表情文字不能乱用 (opens new window)
# write a good commit message
- A Note About Git Commit Messages (opens new window)
- How to write a Git Commit Message (2014) (opens new window)
- how to write a good git commit message (opens new window)
- 5 Useful Tips For A Better Commit Message (opens new window)
- Udacity Git Commit Message Style Guide (opens new window)
- How to commit a change with both “message” and “description” from the command line? (opens new window)
# 原文地址 liuchengxu/git-commit-emoji-cn (opens new window)
# gitmoji-cli
- 一个 gitmoji (opens new window) 交互式客户端，用于在提交消息上使用gitmojis，可以直接在命令行中选择。