使用小圖示(Emoji)建立一目瞭然 commit 訊息

之前有寫過一篇 git commit 訊息撰寫建議和範例 ,主要是在 commit 訊息最前面加上特定約定好的類型來幫助團隊了解此 commit 的內容和功用,然後再使用指定格式撰寫訊息內容。

不過後來筆者發現了這個專案 - Gitmoji

發現上面的 commit 訊息了嗎?每個訊息的第一個「字」都是使用小圖示(emoji)

gitmoji 這個專案主要是在建立和提倡一套共用的 commit 圖示,方便開發者辨識。不過因為沒有強制性,所以任何人都可以使用任何圖示代替,當然,最好是要先讓整個開發團隊有共識,才不會造成更大的混亂。

要查看完整圖示可以到 gitmoji 官網上,點擊圖片即可複製,也可以搜尋,缺點是全英文和沒有分類

使用方式

以 ✨ 圖示為例,輸入方式為 :sparkles: (前後都有冒號), commit 指令為:
  
git commit -m ":sparkles: 新增會員系統"


常用 gitmoji

專案起始

🙈 (:see_no_evil:) 增加或更新 .gitignore 檔案
🏗️ (:building_construction:) 架構更新
🎉 (:tada:) 開始新專案

日常開發

✨ (:sparkles:) 增加新功能
♻️ (:recycle:) 重構
🚚 (:truck:) 移動或重新命名檔案、路徑、API
👽️ (:alien:) 依據外部資源或 API 而進行的更新
💡 (:bulb:) 增加註解
💬 (:speech_balloon:) 新增或更新文字
👔 (:necktie:) 新增或更新業務邏輯
🦺 (:safety_vest:) 新增或更新驗證相關程式碼
🗃️ (:card_file_box:) 與資料庫相關的變更
💥 (:boom:) 重大變更
📝 (:memo:) 新增或更新文件
⚡️ (:zap:) 提升效能

錯誤修正

✏️ (:pencil2:) 修正錯字、拼寫錯誤
🩹 (:adhesive_bandage:) 修正非關鍵性的小問題
🐛 (:bug:) 修正錯誤
🔒️ (:lock:) 修正安全性相關的錯誤
🚨 (:rotating_light:) 修正編譯器或開發工具提出的警告

樣式/介面

💄 (:lipstick:) 增加或更新樣式
💫 (:dizzy:) 新增或更新動畫、樣式
📱 (:iphone:) 響應式介面設計
🚸 (:children_crossing:) 改善使用者體驗(UX 相關)
🌐 (:globe_with_meridians:) 翻譯/多語系相關

日誌

🔊 (:loud_sound:) 新增或更新日誌
🔇 (:mute:) 移除日誌

測試相關

🤡 (:clown_face:) 模擬測試
✅ (:white_check_mark:) 新增或更新能夠正常運作的測試
🧪 (:test_tube:) 新增或更新不能夠正常運作的測試

依賴

➕ (:heavy_plus_sign:) 增加依賴
➖ (:heavy_minus_sign:) 移除依賴 ⬆️ (:arrow_up:) 升級依賴本
📌 (:pushpin:) 固定依賴版本
⬇️ (:arrow_down:) 降低依賴版本

發布/建置

🚀 (:rocket:) 部屬
👷 (:construction_worker:) 新增或更新自動部屬系統相關
💚 (:green_heart:) 修正自動部屬系統相關
🧱 (:bricks:) 基礎設施相關的變化

留言