在日常開發過程中,填寫Git Commit Message 經常成為一項繁瑣的任務,尤其是在處理多個修改和復雜變更時。如果你也為此頭疼,今天我們來看看如何通過Cursor ai一鍵生成專業的 Git Commit Message,讓你的開發工作更加輕鬆和高效。
查看代碼更改: 在提交 Git Commit Message 之前,我們需要了解自上次提交以來都做了哪些修改。 Cursor ai 提供了一個命令:@Commit (Diff Of Working State),通過這個命令可以快速獲取當前工作區的所有修改內容。這一步可以確保你清楚地知道每次提交都包含了哪些更新。
結合提示詞生成提交信息:Cursor ai 提供了自定義的Git 提交信息模板,並結合了枚舉類型和提交細節說明,幫助我們根據修改內容快速生成符合規範的提交信息。以下是一個提交信息的模板及類型參考:
Git 提交信息模板:
<type>(<scope>): <subject> // blank line <body> // blank line <footer>
其中, Header (頭部)是必須填寫的部分, Body (主體)和Footer (尾部)是可選項。每一部分的內容都應注意不超過72 字符(或100 字符),避免自動換行影響信息的美觀。
提交類型(Type)枚舉:
feat: 新功能
fix: Bug 修復
docs: 文檔更新
style: 格式化(不影響代碼執行的更改)
refactor: 重構(不新增功能也不修復Bug 的代碼更改)
test: 添加測試
chore: 構建過程或輔助工具的更改
示例:生成的Git Commit Message
假設你修改了一個名為 debug.sh 的腳本,添加了一些註釋以提高可讀性,你可以使用以下命令生成Git 提交信息:
docs(debug): 為 debug.sh 腳本添加註釋在 debug.sh 腳本中添加了中文註釋,以提高腳本的可讀性和可維護性。 - 為安裝 dlv 的命令添加了註釋- 為啟動調試的命令添加了註釋