在使用 git push 命令將代碼推送到 Gitee（或任何 Git 平臺）時，引號中的信息通常指的是 提交信息（Commit Message）。提交信息是對本次代碼修改的簡要描述，規范的提交信息有助于團隊協作和版本管理。

Gitee 提交信息的規范

雖然 Gitee 本身沒有強制格式，但社區普遍遵循以下最佳實踐：

1. 結構化格式（推薦）

采用 標題行 + 空行 + 詳細描述 的結構：

<類型>: <簡短描述>
<空行>
<詳細描述：解釋修改原因、影響范圍等>

• 類型（Type）：常見的類型包括：
  • feat：新功能
  • fix：修復 bug
  • docs：文檔更新
  • style：代碼格式調整（不影響功能）
  • refactor：代碼重構
  • test：添加或修改測試
  • chore：構建流程或輔助工具的變動

示例：

fix: 修復登錄頁面驗證碼不刷新的問題- 原因：驗證碼生成邏輯未正確處理緩存
- 解決方案：每次請求時添加時間戳參數
- 影響范圍：僅登錄模塊

2. 簡短描述的注意事項

• 使用祈使句：用動詞開頭，如 Add feature 而非 Added feature 或 Adds feature。
• 保持簡短：標題行建議不超過 50 個字符。
• 明確目的：避免模糊的描述（如 更新代碼），盡量具體（如 修復用戶注冊時的郵箱格式驗證）。

3. 詳細描述的建議

• 解釋動機：說明為什么做這個修改，而不是簡單描述修改內容。
• 技術細節：必要時提供實現思路或技術方案。
• 關聯 issue：如果有對應的 Gitee Issue，可以在提交信息中引用（如 Closes #123）。

Gitee 特有的規范

Gitee 支持通過提交信息自動關閉 Issue，格式為：

<類型>: <描述>Closes #123  <!-- 合并后自動關閉編號為 123 的 Issue -->
Fixes #456   <!-- 修復了編號為 456 的 Issue -->

工具推薦

為了確保提交信息規范，可以使用以下工具：

1. Commitizen：交互式提交工具，引導你生成符合規范的提交信息。
2. Commitlint：校驗提交信息格式，集成到 CI/CD 流程中防止不規范的提交。

示例對比

不規范的提交信息	規范的提交信息
更新	fix: 修復訂單詳情頁價格顯示錯誤
改了個 bug	fix: 修復購物車結算時折扣計算錯誤
添加新功能	feat: 添加用戶收藏商品的功能
優化代碼	refactor: 重構用戶認證模塊

遵循這些規范可以讓你的提交歷史更清晰，便于團隊成員理解和維護代碼。如果團隊有特定的規范，建議優先遵循團隊約定。