Emoji-Log: 编写 Git 提交消息的新方法

图片来自

照片由 iabzd 拍摄于 Unsplash

我是一名全职开源开发人员——或者，我喜欢称之为，一个 ? 开源巫师。我已经使用开源软件超过十年了，并且构建了数百个开源软件应用程序。

我也是“不要重复自己 (DRY)”原则的忠实拥护者，并且相信编写更好的 Git 提交消息——这些消息具有足够的上下文可以作为开源软件的变更日志——是 DRY 的一个重要组成部分。我编写的众多工作流程之一是 Emoji-Log，这是一个简单的开源 Git 提交日志标准。它通过使用表情符号来创建更好的 Git 提交消息，从而改善开发人员体验 (DX)。

我在构建 VSCode 技巧和窍门存储库，我的 ? Shades of Purple VSCode 主题存储库，甚至一个自动变更日志时都使用了 Emoji-Log，它看起来很漂亮。

Emoji-Log 的理念

我喜欢表情符号（实际上，它是 emoji 的复数）。我非常喜欢它们。编程、代码、极客/书呆子、开源……所有这些本质上都是乏味的，有时甚至是无聊的。表情符号帮助我为混合添加色彩和情感。想要将情感附加到 2D、平面、基于文本的代码世界中，这没什么不对。

与其记住数百个表情符号，不如保持类别小而通用。以下是使用 Emoji-Log 编写提交消息的理念

祈使语气
- 让你的 Git 提交消息使用祈使语气。
- 像发出命令一样编写提交消息。
  - 例如，使用 ✅ 添加而不是 ❌ 已添加
  - 例如，使用 ✅ 创建而不是 ❌ 正在创建
规则
- 少量类别易于记忆。
- 不多也不少
  - 例如 ? 新增、? 改进、? 修复、? 文档、? 发布 和 ✅ 测试
操作
- 基于你采取的操作进行 Git 提交。
- 使用像 VSCode 这样的好编辑器来提交正确的文件以及提交消息。

编写提交消息

只使用以下 Git 提交消息。简单和小足迹是 Emoji-Logo 的关键。

? 新增: 祈使语气_消息
- 当您添加全新的内容时使用。
  - 例如，? 新增: 添加 Git 忽略文件
? 改进: 祈使语气_消息
- 当您改进/增强一段代码（例如重构等）时使用。
  - 例如，? 改进: 远程 IP API 函数
? 修复: 祈使语气_消息
- 当您修复错误时使用。需要我多说吗？
  - 例如，? 修复: 大小写转换器
? 文档: 祈使语气_消息
- 当您添加文档时使用，例如 README.md 甚至内联文档。
  - 例如，? 文档: API 接口教程
? 发布: 祈使语气_消息
- 当您发布新版本时使用。例如，? 发布: 版本 2.0.0
✅ 测试: 祈使语气_消息
- 当您发布新版本时使用。
  - 例如，✅ 测试: 模拟用户登录/注销

目前就这些。不多也不少。

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 中，并向我发送一个拉取请求，以便我可以将您的存储库列在存储库中。