Commit Flow
當用戶要求提交、暫存或準備變更進行提交時使用。
步驟
- 執行 doc-gen — 先啟用/執行
gen-docs技能,根據程式碼變更更新文件。 - 檢查目前變更 — 執行
git status和git diff(或git diff --cached)以準確查看變更內容。 - 審閱程式碼 — 讀取已修改/新增的檔案,了解實際需要的內容。
- 僅暫存必要的程式碼 — 直接讀取檔案;加入包含真正、必要變更的檔案。對於看起來不相關、臨時或不明確的檔案,詢問用戶:「是否應該暫存
<檔案>?它包含<簡要摘要>」— 不要假設。 - 根據程式碼變更提供訊息 — 從實際的 diff/內容推導提交訊息(例如
feat: add docs for skills a)。 - 與用戶確認 — 顯示提議的訊息、doc-gen 結果和暫存的檔案;在提交前請求批准(
yes/approve)。 - 提交程式碼 — 使用批准的訊息執行
git commit,然後顯示提交內容的簡要摘要。 - 詢問是否推送 — 詢問用戶是否要推送(
git push)。
規則
- 在此流程中直接使用
git、read_file、write_file和檔案工具 — 不需要為每個工具呼叫請求許可。 - 若不確定某個變更是否需要,詢問:「是否應該暫存
<檔案>?它包含<簡要摘要>」 - 在提交前執行
gen-docs。 - 根據實際 diff 建議提交訊息(格式範例:
feat: add docs for skills a)。 - 在
git commit和git push前與用戶確認(yes/approve);其他步驟直接進行。