EricLog
Published in

EricLog

Conventional Commits 和 commitlint

Conventional Commits 是一個簡單的 Git commit message 約定,用來規定 commit message 的寫法。Git 本身就沒有規定 commit message 的內容格式,所以不同人會有不同的做法。如果 repository 只是有一個或幾個人用的話,那問題就不大。但如果在開源軟件或者公司這類多人同時參與的 repository 時,不同風格的 commit message 會令人花額外的時間來了解 repository 的變動。如果再加上一部分的 commit message 內容空洞的時候(例如只寫「fix」、「commit」、「修正錯誤」等等),情況就會失控。

一般的 Git client 因為界面空間和方便檢索,在顯示紀錄時都是顯示 commit message 的第一行。所以第一行是最重要。

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

--

--

--

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store
Eric Li

Eric Li

Hongkonger + Android developer

More from Medium

GRANITE VS QUARTZ | WHICH ONE SHOULD YOU OPT FOR?

Conditional Ternary Operator “?” C#, Why (not always) is not “If sentence” replacement

7 Exercises to Boost Your Overall Stamina

Logitech MX Master 3 — first impressions

logitech Mx Master 3