Conventional Commits
在建立提交時,請遵守以下專案特定規則。
分支
切勿建立裸分支。 如果您需要分支隔離,請使用 worktree 技能。對於簡單的變更,請直接在主分支(包括 main)上提交。不要執行 git checkout -b。
專案規則
- 每個邏輯變更一個提交—絕不將不相關的修復或功能合併。三個獨立的變更 = 三個提交。
- 只提交您變更的檔案—絕不從並行工作階段引入不相關的檔案。
- 始終包含主體—不接受只有標題的提交。請說明做了什麼以及為什麼。
merge類型—在合併工作樹或功能分支時使用merge(不要使用合併提交)。- 安排提交順序以最大化選項價值—先建立基礎架構,再建立依賴它的功能。
範例
feat(alerts): 為警示更新新增 Slack 執行緒回覆
當警示更新或解決時,回覆原始 Slack 執行緒,而不是建立新訊息。
這有助於將相關通知群組在一起。