Andy的前後端技術筆記、生活紀錄
什麼時候該git commit, commit message該如何寫?
發佈於: 2024-04-25 更新於: 2024-04-25 分類於: frontend

何時該git commit?

我一直在想到底幾時該commit,有時後在commit都會覺得怎麼這麼多程式碼,這樣會不會太雜?
是否要等到整個feature都完成後才commit?

我稍微找一下資料,可以參考以下文章Git Commit Best Practices

Commit 建議

  • Commit Related Changes : commit相關的修改,如果有不同功能的bug/feature,要分開commit,不要一次commit,這樣才不容易搞混此次commit的內容
  • Commit Often : 經常commit,不要程式碼已經變得非常大包才commit,這樣如果其他人pull下來碰到conflict就會變得非常難處理
    Don’t Commit Half-Done Work : 如果該功能或是bug還沒完成不要commit,使用的人可能會碰到crash之類的狀況
  • Test Your Code Before You Commit : 當你認為完成了,要做測試,而且是確認功能正常運作
  • Write Good Commit Messages:除了描述做什麼,還查了下網路上的一些文章,有些人會推薦前面加上feat, bugfix, style之類的前綴字,讓commit message可以一眼就知道該commit是做什麼
    -Use Branches:使用brach,如果有修改bug, feature時,切出去分支,可以讓你的開發與main branch以及其他開發者開發不會混在一起。

參考文章
https://wadehuanglearning.blogspot.com/2019/05/commit-commit-commit-why-what-commit.html
https://hackmd.io/@dh46tw/S1NPMsy5L

--- 到底拉 The End ---