Emoji-Log：一种编写 Git 提交信息的新方法

图片来源：

照片由 iabzd 拍摄于 Unsplash

我是一名全职开源开发者——或者，正如我喜欢称呼自己的，一个 ? 开源巫师。我从事开源软件开发已经超过十年，并且构建了数百个开源软件应用。

我也是“不要重复自己 (DRY)”哲学的忠实粉丝，并且认为编写更好的 Git 提交信息——那些上下文足够丰富，可以作为你的开源软件的变更日志的提交信息——是 DRY 的一个重要组成部分。我编写的众多工作流程之一是 Emoji-Log，一个直接明了的开源 Git 提交日志标准。它通过使用 emoji 来创建更好的 Git 提交信息，从而提升了开发者体验 (DX)。

在构建 VSCode Tips & Tricks 代码仓库、我的 ? Shades of Purple VSCode 主题代码仓库，甚至一个自动变更日志（看起来很漂亮）时，我都使用了 Emoji-Log。

Emoji-Log 的理念

我喜欢 emoji（实际上，emoji 是 emoji 的复数形式）。我非常喜欢它们。编程、代码、极客/书呆子、开源……所有这些本质上都是枯燥乏味的。Emoji 帮助我为其中添加色彩和情感。想要将情感附加到 2D、扁平、基于文本的代码世界中并没有什么错。

与其记住数百个 emoji，我发现最好保持类别小而通用。以下是指导使用 Emoji-Log 编写提交信息的理念

祈使语气
- 让你的 Git 提交信息使用祈使语气。
- 像下命令一样编写提交信息。
  - 例如，使用 ✅ Add 而不是 ❌ Added
  - 例如，使用 ✅ Create 而不是 ❌ Creating
规则
- 少量类别易于记忆。
- 仅此而已
  - 例如，? NEW、? IMPROVE、? FIX、? DOC、? RELEASE 和 ✅ TEST
操作
- 基于你采取的操作进行 Git 提交。
- 使用像 VSCode 这样的优秀编辑器来提交正确的文件和提交信息。

编写提交信息

仅使用以下 Git 提交信息。简单和小巧是 Emoji-Logo 的关键。

? NEW：祈使信息
- 当你添加全新的内容时使用。
  - 例如，? NEW：添加 Git 忽略文件
? IMPROVE：祈使信息
- 当你改进/增强代码片段（例如重构等）时使用。
  - 例如，? IMPROVE：远程 IP API 函数
? FIX：祈使信息
- 当你修复 bug 时使用。还需要我多说吗？
  - 例如，? FIX：大小写转换器
? DOC：祈使信息
- 当你添加文档时使用，例如 README.md 甚至内联文档。
  - 例如，? DOC：API 接口教程
? RELEASE：祈使信息
- 当你发布新版本时使用。例如，? RELEASE：版本 2.0.0
✅ TEST：祈使信息
- 当你添加测试或与测试相关的更改时使用。
  - 例如，✅ TEST：模拟用户登录/登出

目前就这些。仅此而已。

Emoji-Log 函数

为了快速原型开发，我制作了以下函数，你可以将它们添加到你的 .bashrc/.zshrc 文件中，以便快速使用 Emoji-Log。

#.# Better Git Logs.
### Using EMOJI-LOG (https://github.com/ahmadawais/Emoji-Log).

# Git Commit, Add all and Push — in one step.
function gcap() {
    git add . && git commit -m "$*" && git push
}

# NEW.
function gnew() {
    gcap "? NEW: $@"
}

# IMPROVE.
function gimp() {
    gcap "? IMPROVE: $@"
}

# FIX.
function gfix() {
    gcap "? FIX: $@"
}

# RELEASE.
function grlz() {
    gcap "? RELEASE: $@"
}

# DOC.
function gdoc() {
    gcap "? DOC: $@"
}

# TEST.
function gtst() {
    gcap "✅ TEST: $@"
}

要为 fish shell 安装这些函数，请运行以下命令

function gcap; git add .; and git commit -m "$argv"; and git push; end;
function gnew; gcap "? NEW: $argv"; end
function gimp; gcap "? IMPROVE: $argv"; end;
function gfix; gcap "? FIX: $argv"; end;
function grlz; gcap "? RELEASE: $argv"; end;
function gdoc; gcap "? DOC: $argv"; end;
function gtst; gcap "✅ TEST: $argv"; end;
funcsave gcap
funcsave gnew
funcsave gimp
funcsave gfix
funcsave grlz
funcsave gdoc
funcsave gtst

如果你愿意，你可以将这些别名直接粘贴到你的 ~/.gitconfig 文件中

# Git Commit, Add all and Push — in one step.
cap = "!f() { git add .; git commit -m \"$@\"; git push; }; f"

# NEW.
new = "!f() { git cap \"? NEW: $@\"; }; f"
# IMPROVE.
imp = "!f() { git cap \"? IMPROVE: $@\"; }; f"
# FIX.
fix = "!f() { git cap \"? FIX: $@\"; }; f"
# RELEASE.
rlz = "!f() { git cap \"? RELEASE: $@\"; }; f"
# DOC.
doc = "!f() { git cap \"? DOC: $@\"; }; f"
# TEST.
tst = "!f() { git cap \"✅ TEST: $@\"; }; f"

Emoji-Log 示例

以下是使用 Emoji-Log 的代码仓库列表。

Create-guten-block 工具包
VSCode Shades of Purple 主题
Ahmad Awais 的 GitHub 代码仓库（我最新的代码仓库）
CaptainCore CLI (WordPress 管理工具包)
CaptainCore GUI (WordPress 插件)
你呢？ 如果你的代码仓库使用了 Emoji-Log，请将 Emoji-Log 徽章添加到你的 README 中，并向我发送一个拉取请求，这样我就可以将你的代码仓库列入列表中。