🔨 [git]：使用 Gitmoji 编写更好的提交

2025-05-25

🔨 [git]：使用 Gitmoji 编写更好的提交

图像

📝 注释

Gitmoji 是一项旨在标准化和解释 GitHub 提交消息中表情符号使用的计划。

📝 简介：如何编写 Git 提交消息

图像

就我而言，只有当我想追踪提交的变更或挖掘提交说明时，我才会阅读提交内容。否则，我会直接阅读源代码。

下面是一个良好的 git 提交消息语义的示例（根据Gist Semantic Commit Messages）



<type> [scope]: "Message"
Enter fullscreen mode Exit fullscreen mode

类型必须是下列之一：

  • <build>：构建相关更改（例如：npm 相关/添加外部依赖项）
  • <chore>：外部用户看不到的代码更改（例如：更改为 .gitignore）
  • <docs>：文档相关的更改
  • <feat>：引入新功能
  • <fix>：解决与开发直接相关的问题（错误修复）
  • <hotfix>：解决与生产直接相关的问题（补丁）
  • <test>：添加/更新测试用例
  • <performance>：添加提高性能的代码
  • <refactor>：更新代码以提高可维护性（干净的代码）

范围是可选的，并且必须是表示代码库部分的名词

消息应该是必要的，并且应该用清晰的信息/关键字描述提交。

提交示例：



feat(home, components): Add login button
feat(home, components): Add login modal
fix(home, components): Resolve issue with modal collapses
chore(home): Move icons folder
feat(newsletter): Add Newsletter component
feat(navbar): Add navbar container
Enter fullscreen mode Exit fullscreen mode

🚀 吉莫吉

图像

在提交信息中使用表情符号，只需查看所使用的表情符号，就能轻松识别提交的目的或意图。由于表情符号种类繁多，我发现有必要创建一个指南，帮助大家更轻松地使用表情符号。

现在我们可以用表情符号替换 <type/> ：

🎨 改进代码的结构/格式。

⚡️提高性能。

🔥 删除代码或文件。

🐛 修复一个错误。

✨ 介绍新功能。

📝 添加或更新文档。

🚀 部署东西。

💚 修复 CI 构建。

👷 添加或更新 CI 构建系统。

🔧 添加或更新配置文件。

🔨 添加或更新开发脚本。

⚰️ 删除无效代码。

提交示例：



✨ (home, components): Add login button
✨ (home, components): Add login modal
🐛 (home, components): Resolve issue with modal collapses
🚚 (home): Move icons folder
✨ (newsletter): Add Newsletter component
✨ (navbar): Add navbar container
🔥 (navbar): Remove old navbar file
✅ (home): Add login test case
🎨 (home, component): Improve login modal
📦️ (npm): Add react-table
🔨 Update script start-server.js
Enter fullscreen mode Exit fullscreen mode

附加图标



🐳 Add Dockerfile
🐳 Add docker-compose.yml
☸️ (helm): Add postgres helm chart
☸️ (helm): Update frontend.yaml
☸️ (helm): Update pvc.yaml
🐎 (home): Increase speed load for navbar
🍎 (home): Fix issue with MacOS for navbar
Enter fullscreen mode Exit fullscreen mode

链接：EmojiPedia

📦️ Gitmoji-CLI

图像

用于在提交消息上使用 gitmojis 的 gitmoji 交互式客户端。

安装

使用 npm ：



npm install gitmoji-cli
Enter fullscreen mode Exit fullscreen mode

在 MacOS 上：



brew install gitmoji
Enter fullscreen mode Exit fullscreen mode

交互式客户端

启动交互式提交客户端，根据您的提示自动生成您的提交。



gitmoji -c
Enter fullscreen mode Exit fullscreen mode

钩

运行 init 选项，添加您的更改并提交它们，之后提示将开始，并且您的提交消息将被构建。



gitmoji -i
git add .
git commit
Enter fullscreen mode Exit fullscreen mode

图像

搜索

使用特定关键字搜索以找到正确的 gitmoji。



gitmoji -s "criteria"
Enter fullscreen mode Exit fullscreen mode

图像

列表

漂亮地打印所有可用的 gitmojis。



gitmoji -l
Enter fullscreen mode Exit fullscreen mode

图像

配置

运行 gitmoji -g 来设置一些 gitmoji-cli 首选项。



gitmoji config
Enter fullscreen mode Exit fullscreen mode

图像

🔨扩展（与 IDE 集成）

适用于 Vscode 的 Gitmoji

图像

链接：https://marketplace.visualstudio.com/items?itemName =Vtrois.gitmoji-vscode

Atom 版 Gitmoji

转到设置（cmd + ，或 ctrl + ,）> 安装并搜索 gitmoji-atom。

或者，运行以下命令：



apm install gitmoji-atom
Enter fullscreen mode Exit fullscreen mode

链接：https://atom.io/packages/gitmoji-atom

💻 与 DEV.TO 集成？

您认为我们可以在为 Dev.TO 撰写帖子时使用它吗？




🐳 Docker

☸️ Kubernetes

...
Enter fullscreen mode Exit fullscreen mode




链接

文章来源：https://dev.to/javidjms/git-write-better-commits-with-gitmoji-3193
Devto 翻译
PREV
10 Best Books to Learn Data Structure and Algorithms in Java, Python, C, and C++
NEXT
使用 Yarn 将 React 应用部署为 Github 用户页面