Git 提交的最佳實踐是什麼?
以下是 Git 提交的最佳實踐:
進行小的、單一目的的提交
提交小的程式碼段有助於團隊理解已完成的工作。較小的提交更容易回退,並有助於維護穩定的程式碼庫。一次提交應像一個圍繞一組更改的包裝器。這意味著如果您正在修復兩個不同的錯誤,請使用兩個不同的提交。換句話說,邏輯相關的更改或程式碼應屬於單個提交。
提交訊息應簡短而詳細
提交訊息應以對更改的簡短總結開頭。總結應使用現在時態。主題行應大寫,不超過 50 個字元,後跟一個空行。提交訊息應清晰明瞭,準確解釋您所做的工作。建議使用編輯器新增提交的詳細描述。詳細描述有助於您更好地向其他團隊成員解釋您的程式碼。如果您在不使用 -m 標誌的情況下鍵入 git commit,Git 將開啟預設編輯器,您可以在其中新增描述。下面的螢幕截圖演示了這一點。
提交前測試您的程式碼
在提交之前測試和審查程式碼是必要的,以確保程式碼庫的質量不會受到影響。程式碼應該經常測試,並在測試完成後提交。
經常提交
當您完成可以邏輯分組的較小的程式碼單元時,進行提交。頻繁提交確保更改定期整合,並有助於避免合併衝突。同樣重要的是,在提交程式碼之前對其進行測試和審查錯誤。
使用分支
分支是獨立的開發線路,是 Git 的強大功能工具。分支幫助您維護程式碼的不同版本,並避免混淆不同的開發線路。不要直接將程式碼推送到主分支。為不同的開發工作流程建立和維護單獨的分支。例如,為新功能、錯誤修復、想法等建立單獨的分支。
配置提交作者身份
提交時正確設定您的姓名和電子郵件地址。這些詳細資訊將幫助您瞭解誰進行了特定的更改。如果您想詢問作者有關程式碼的業務背景或技術目的,此資訊將來會對您有所幫助。它還有助於加快錯誤修復,或追蹤導致程式碼庫中存在錯誤的提交。
商定工作流程
Git 工作流程定義了使用 Git 進行程式碼協作的標準流程,團隊內部應遵循該流程。有各種型別的 Git 工作流程,選擇最適合您的專案型別的工作流程非常重要。重要的是團隊討論並商定一個工作流程並遵守它。