小編精選 - 技術文章翻譯 · 02月08日

Git Good：分支命名和 commit 訊息的最佳實踐

開發者們大家好，我將分享一些更有效地使用 Git 的最佳實踐。Git？是的，就是你已經熟悉的 git。程式碼夥伴是您的守護天使，可確保您的程式設計冒險順利進行，讓開發人員能夠輕鬆地進行專案協作。

你是那個建立分支然後忘記它們存在的原因的人嗎？總是需要尋找文件變更才能理解提交？這裡有一些建議供您參考。

我為什麼要遵循標準？

例如： feature/login 、 bugfix/navbar-overflow

例如， bugfix/fix-login-issue比bugfix/fixLoginIssue或bugfix/fix_login_issue更具可讀性。

例如， feat/new--login-是一種不好的做法。

如果您的專案使用 Jira 等問題追蹤系統，或者它根據 github 問題或其他類似工具進行修改。在分支名稱中包含問題的令牌將使追蹤變得簡單。範例： feature/PROJ-123-footer-links

  <type>([optional scope]): <description>  # subject

  [optional body]

  [optional footer(s)]

例如：使用fix: Fix bug #67比fix: Fixed bug #67

簡短總結：嘗試將主題行控制在 50 個字元以內，以確保訊息在各種 Git 工具中可讀，例如使用git log --oneline時。避免尾隨句點和不必要的單字/符號。
將描述大寫：這聽起來很簡單。主題行以大寫字母開頭。

主題行中的type前綴可用於表示提交中包含的變更的類型。一些常用的類型是：
feat: ：總結程式碼庫中的新功能。
fix: ：修復程式碼庫。
build: 、 chore: 、 ci: 、 style: 、 refactor:是其他一些例子。
可以將scope加入到提交的類型中以提供額外的上下文訊息，並將其括在括號中，例如feat(parser): Add the ability to parse arrays
可以將body新增至訊息中，以在提交中包含詳細說明。
在主題行後面留空行來加入正文。
將正文包裹在 72 個字元處，即。使用多行正文，每行不超過 72 個字元。

footer用於傳達有關提交的附加訊息，例如審查者、批准者等。例如：
Signed-off-by: Alice <[email protected]>
重大變更： BREAKING CHANGE是指程式碼庫中相當重要的重大變更。可以透過加!來表示。在類型/範圍之後和/或透過將其加入到body或作為footer

  chore!: drop support for Node 6

  BREAKING CHANGE: use JavaScript features not available in Node 6.

可以在此處找到提交訊息的各種用例範例。

遵守 Git 約定類似於說通用語言。然而，很明顯，這些標準或約定並沒有被任何系統強制執行；因此，這些標準的調整和擴展使用完全取決於我們。

養成這些習慣肯定會改善您的 Git 體驗並鼓勵協作編碼環境。儘管我們不能一下子就遵循這些，但逐漸適應它們無疑會有所不同。

我計劃寫一篇關於使用 Husky 實現 Git 約定的文章，透過反應和評論來表達您的支持。快樂編碼！

0個讚 0留言 883瀏覽

共有 0 則留言

登入之後發表留言

文字內容提供幾種功能：
1) --- 會變成分隔線（上一行必須是空白）
2) # 會變成一級標題
3) ## 會變成二級標題
4) ### 會變成三級標題
5) **粗體文字**會顯示粗體文字
6) ```當第一行與最後一行會顯示程式碼
7) 請搜尋 Markdown 語法，了解各種格式

精選技術文章翻譯，幫助開發者持續吸收新知。