"A good commit shows whether a developer is a good collaborator." — Peter Hutterer, Linux.
幾年前，我從未意識到編寫提交訊息有特定的規則，直到我的好奇心戰勝了我。我曾經認為像「新增功能 2」、「修復主導覽列上的錯誤」甚至「foo」這樣簡單的訊息就足夠了。認為提交資訊基本上未被閱讀的信念被證明是錯誤的。事實上，精心設計的承諾訊息是不可或缺的，它可以確保我們未來的自己從我們的勤奮和深思熟慮中受益。
為什麼你應該關心寫乾淨的提交訊息
提交是程式設計師技術的有形建置塊。它們充當程式碼的錦上添花，如果編寫正確，它們會帶來巨大的價值。編寫良好的提交訊息變得不可或缺，因為它們提供了上下文 - 否則，一開始就不需要提交訊息。
"A good commit shows whether a developer is a good collaborator." — Peter Hutterer, Linux.
提交訊息中的常見錯誤
在深入研究規則之前，讓我們先解決開發人員經常犯的一些常見錯誤：
1. 含糊的訊息
-
範例：“修復它”
-
為什麼不好：這沒有提供有關修復內容或修復位置的上下文。
2. 資訊過多
-
範例：“重構了整個應用程式，修復了所有錯誤，並加入了新功能，更新了文件。”
-
為什麼不好：這使得很難確定到底做了什麼。
3. 不相關的細節
-
範例：“喝了咖啡，然後修復了錯誤 #1234”
-
為什麼不好：個人軼事不屬於提交訊息。
撰寫完美提交訊息的 7 條規則
- 保持簡短而甜蜜
-
將主題行限制為 50 個字元或更少。
-
範例：“新增使用者身份驗證”
- 使用祈使語氣
-
將您的提交訊息視為命令。
-
範例：“修復登入錯誤”而不是“修復登入錯誤”或“修復登入錯誤”
- 用空白行將主體與正文分開
-
有助於提高可讀性和清晰度。
-
例子：
Add user authentication
Implemented JWT for secure authentication.
Updated user model to include password hashing.- 主題行大寫
- 範例：“使用安裝說明更新自述文件”
- 不要以句號結束主題行
- 範例：“提高資料獲取的效能”
- 用身體來解釋什麼和為什麼，而不是如何
- 例子：
Refactor user service
Split the user service into smaller, more manageable functions.
This will help in maintaining and testing the code more efficiently.- 始終如一
- 在所有提交訊息中保持一致的風格。
案例研究：從壞到好
錯誤的提交訊息：
Fixed issue #456改進的提交訊息：
Resolve issue #456: Fix null pointer exception in UserService
The null pointer exception was occurring due to an uninitialized object.
Added a check to initialize the object before accessing its properties.編寫更好的提交訊息的技巧
- 打字前請三思
- 反思你所做的事情以及為什麼它很重要。
- 使用工具和模板
-
利用提交訊息範本來確保一致性。
-
範例模板：
Subject: [TASK] - Description
Body:
- What was done
- Why it was done
- Any additional notes- 提交前審查
- 在最終確定之前，請務必閱讀您的提交訊息。
- 與您的團隊合作
- 與您的團隊討論並商定提交訊息約定。
結論
編寫良好的提交訊息是每個開發人員都應該掌握的藝術。它們不僅僅是一種形式，而且是開發過程的關鍵部分，有助於理解專案的歷史和演變。透過遵循這些準則，您可以確保您的提交訊息清晰、簡潔並對您的團隊有價值。
透過採用這些實踐，您不僅可以改善自己的工作流程，還可以增強團隊內部的協作和生產力。請記住，良好的提交訊息是勤奮且深思熟慮的開發人員的標誌。因此，下次您準備做出承諾時，請花點時間精心製作完美的訊息。
這就是今天的全部內容。
另外，分享您最喜歡的網頁開發資源來幫助這裡的初學者！
探索我的YouTube頻道！如果你覺得有用的話。
請給我的GitHub專案一顆星 ⭐️
感謝23428！ 🤗
原文出處：https://dev.to/safdarali/good-commit-vs-your-commit-how-to-write-a-perfect-git-commit-message-59ol
1) --- 會變成分隔線（上一行必須是空白）
2) # 會變成一級標題
3) ## 會變成二級標題
4) ### 會變成三級標題
5) **粗體文字**會顯示粗體文字
6) ```當第一行與最後一行會顯示程式碼
7) 請搜尋 Markdown 語法，了解各種格式