在日常程式設計協作中,Git 提交記錄的品質往往體現了一個工程師的工程素養。然而,我經常看到一些不標準的提交記錄,相當尷尬。
例如:
這可能是由於在提交後進行了更改並隨意重用了先前的 git commit 命令。
雖然這在個人儲存庫中可能是可以接受的,但在協作儲存庫中有點不專業。
在我看來,這些提交記錄是不必要的,代表著壞習慣,是可以完全避免的。
幸運的是,Git 為我們提供了一個優雅的解決方案。如果不需要產生新的提交,使用 git commit --amend 可以避免這個問題。
例如:
Merge branch 'feature-A' of https://github.com/qiniu/reviewbot into feature-B
這表示將程式碼從遠端分支功能 A 合併到功能 B 中。在這裡,功能 A 通常是主分支。
此類提交訊息在您的 PR 中是不必要的。 PR 提交訊息應該只包含有關當前變更的有用資訊。
就我個人而言,我很少使用 git merge,即使是同步遠端分支,我通常也使用 git rebase。
例如:
除了上述好處之外,git rebase 還有助於在主儲存庫中維護非常乾淨的提交歷史記錄。因此,我強烈推薦使用它。
Reviewbot是七牛雲的開源項目,旨在提供自架的程式碼審查服務,方便程式碼審查/靜態分析以及自訂工程標準的實作。
為了更好規範這兩種行為,Reviewbot 新增了 git commit check 功能,用於驗證 git commit 記錄是否符合標準。
如果不符合標準,Reviewbot 會通知您:
當然,git操作還有很多實用技巧。我鼓勵有興趣的人去探索它們。我在1024訓練營期間給學員們分享相關內容:
超實用!從使用者角度看Git協作,告別死記硬背
此文件包含有興趣的讀者的影片連結。
最後,身為專業工程師,我們應該在工程實務中始終追求卓越。良好的提交記錄不僅反映了個人的專業素質,也是提高團隊協作效率的重要基石。
透過正確使用 git rebase 和 git commit --amend,我們可以維護更清晰、更專業的程式碼提交歷史記錄。這不僅讓程式碼審查變得更加容易,也為後續的程式碼維護和問題追蹤帶來了極大的便利。
你覺得怎麼樣?
以上是有些 git commit 歷史真的很尷尬,我建議所有工程師都常常使用 git rebase 和 git commit --amend的詳細內容。更多資訊請關注PHP中文網其他相關文章!