當涉及版本控制時,Git 是一個非常有效的工具。然而,像任何其他工具一樣,您必須以正確的方式使用它才能充分利用它。您需要考慮不同的方面。本文重點介紹如何按照常規提交規範編寫有效的 Git 提交訊息。它概述了幫助您建立清晰、資訊豐富且標準化的提交訊息的基礎知識。

好的提交訊息是什麼樣的?

發送訊息的目的是為了溝通。為了使溝通有效,接收者必須清楚地了解訊息發送者試圖告訴他們什麼。因此,您需要提供上下文和足夠的資訊。基於此,一個好的提交訊息應該傳達以下內容:

1. 類型(必填)

  • fix: – 適用於修復錯誤的操作。

  • feat: – 當您新增功能時適用。

  • BREAKING CHANGE: - 當您引入以下變更時適用

可能需要更新程式的某些方面或

升級以避免中斷。例如,替換已棄用的

如果有的話,新資源可能會破壞功能

沒有向後相容性。您也可以指示中斷

使用符號“!”進行更改緊接在類型(或範圍,如果

可用的)。

例子; '壯舉(身份驗證)!

  • docs: – 適用於文件。

其他包括test:、chore:、refactor:、build:、style:等。因此,提前了解詳細資訊很重要。

2.範圍(可選)

儘管提供範圍是可選的,但為了清晰起見,最好將其包含在內。範圍指定了受變更影響的程式碼庫部分,從而幫助讀者了解變更的上下文。這對於有許多貢獻者的大型專案尤其有用。它使協作變得更加容易。

3. 說明(必填)

這是您描述您所做的事情的部分。保持簡潔、開門見山。確保以命令式形式編寫。例如,不應編寫“新增身份驗證機制”,而應編寫“新增身份驗證機制”。這將提高自動產生的變更日誌和發行說明的可讀性。

4. 本體(可選)

您可以在此處提供有關您已實施的內容的更多資訊。使用空白行將正文與描述分開。

5.頁尾(可選)

如果您想在頁腳中包含任何元資料,請執行此操作。例如,如果您所做的變更解決了先前提出的問題,您可以透過引用參考號在此指出。例子; '修復#003 '

您也可以在頁腳中包含審閱者的姓名。

請記住,在給出描述之前,範圍後面應該跟有冒號和空格。您還應該記住,BREAKING CHANGE 在包含在頁腳中時區分大小寫,因此應以大寫形式書寫。

例子

  • Chore(Art_func):將變數“Empty”更改為“empty”

將變數名稱從“Empty”更改為“empty”以保持一致

命名約定。

  • 修復(資料庫)!

修改架構以僅容納結構化資料。關閉所有

其他類型的資料。

  • 壯舉:增加對黑暗模式的支援。

對於長訊息,請使用文字編輯器執行

git commit

沒有 -m 標誌。這將打開一個編輯器,您可以在其中編寫詳細的提交訊息。對於較短的訊息,您可以僅包含 -m 標誌並使用終端機而不是編輯器。

git commit -m "subject" -m "body"

使用多個 -m 標誌可以透過分隔主題、正文和頁腳來幫助您正確格式化訊息。

結論

編寫提交訊息應該達到預期目的。為了使其清晰且資訊豐富,建議您至少包含所做更改的類型和描述。按照傳統方法維護一個良好的程式碼庫,可以支援各種流程的協作和自動化。有關詳細訊息,請務必閱讀常規提交指南。


原文出處:https://dev.to/otienorabin/are-you-writing-your-git-commit-messages-properly-54cl


共有 0 則留言