2023年了,還有前端人不知道 commit 規范?
時間:2023-11-01 來源:華清遠見
什么是commit規范?
約定式提交(Conventional Commits)是一種用于代碼版本控制的規范,旨在通過明確和標準化提交信息來提高代碼協作質量和效率。其基本原則是通過規定提交信息的結構和語義來提高代碼版本控制的可讀性、可維護性和自動化程度。
點單來說,commit 規范是一種約定俗成的代碼提交規則,皆在提供一種同意的格式,是團隊成員能夠更好的理解和管理代碼的變更歷史。通過遵循 commit規范,可以更清晰的了解每個代碼提交的目的和意義,從而提高代碼的可讀性、可維護性和協作效率。
commit的作用是什么?
約定式提交規范通常要求提交信息包括一個描述性的"類型"、一個可選的"作用域"、一個用于簡潔說明的"主題",以及可選的"正文"和"尾部"等組成部分。這些組成部分的格式和語義都是根據規范要求進行約定的,比如使用"feat"來表示新功能、"fix"表示修復錯誤、"docs"表示文檔變更等。
通過遵循約定式提交規范,開發人員可以更容易地理解和管理代碼的變更歷史,同時也為自動化工具提供了更多可靠的信息,例如自動生成版本號、發布日志和代碼庫更新等操作。
在當今的軟件開發領域,版本控制是一個至關重要的環節。無論是個人項目還是團隊合作,版本控制系統都能幫助我們跟蹤代碼的變化、協作開發和回滾不必要的更改。而在版本控制中,Git已經成為了最受歡迎的工具之一。
然而,盡管很多前端開發人員已經開始使用Git進行版本控制,但仍然有一些人對如何正確提交代碼存在一些困惑。
為什么要遵循 commit 規范?
我們來看一下不規范的commit記錄:

大家看完以后是什么感覺,寫的全是update,這種commit信息對于想要從信息中獲取有效信息的人來說簡直就是噩夢。
我們來看一個Angular團隊 的commit記錄:

我們很明顯就可以看出兩者的區別所在。
上圖中這種規范的commit 信息提供了更多的歷史信息,方便快速瀏覽。再者,可以過濾某些commit(如文檔改動信息),便于快速查找信息。
下面我們具體深入了解一下commit規范。
如何遵循 commit 規范?
Commit Message的規范有以下幾種:
其中 Angular團隊 的規范是目前社區比較流行的commit規范,他在功能上能夠滿足開發者commit需求,在格式上清晰易讀,目前也是用的最多的。






