Spaces:
Running
Running
Commit
·
201336d
1
Parent(s):
de4f1bc
feat: add prompt files for review checkpoints in workflow
Browse files- .github/copilot-instructions.md +19 -0
- .github/prompts/apply.prompt.md +17 -0
- .github/prompts/dry-run.prompt.md +12 -0
- .github/prompts/plan.prompt.md +24 -0
- .github/prompts/propose.prompt.md +21 -0
- .github/prompts/report.prompt.md +12 -0
- .github/prompts/test.prompt.md +15 -0
.github/copilot-instructions.md
CHANGED
|
@@ -52,3 +52,22 @@
|
|
| 52 |
- 當某個任務或一批變更完成時,請在 `change-log.md` 新增一個條目,摘要說明本次改變了什麼(可跨多個 Task 合併記錄,非一對一)。
|
| 53 |
- 條目建議包含:Highlights、Spec/契約影響、行為或 I/O 變更、資料檔影響、降級與 Logging、測試與驗收、風險與回滾、連結(PR/Commits/Task IDs)。
|
| 54 |
- 條目完成後,可刪除或重置 `docs/task.md`;下次任務開始時請以 `docs/task-template.md` 重新建立。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 52 |
- 當某個任務或一批變更完成時,請在 `change-log.md` 新增一個條目,摘要說明本次改變了什麼(可跨多個 Task 合併記錄,非一對一)。
|
| 53 |
- 條目建議包含:Highlights、Spec/契約影響、行為或 I/O 變更、資料檔影響、降級與 Logging、測試與驗收、風險與回滾、連結(PR/Commits/Task IDs)。
|
| 54 |
- 條目完成後,可刪除或重置 `docs/task.md`;下次任務開始時請以 `docs/task-template.md` 重新建立。
|
| 55 |
+
|
| 56 |
+
---
|
| 57 |
+
|
| 58 |
+
Copilot Slash Commands(審核檢查點工作流)
|
| 59 |
+
- 本專案提供以下指令(位於 `.github/prompts/*.prompt.md`),協助「先審核、後套用」:
|
| 60 |
+
- `/plan`:產出計畫與驗收標準,不改檔、不跑命令。
|
| 61 |
+
- `/propose`:列出變更檔案與具體變更點,等待「套用」。
|
| 62 |
+
- `/apply`:依核准內容實作並做最小必要驗證。
|
| 63 |
+
- `/test`:執行最小測試或冒煙,彙整 PASS/FAIL 與後續建議。
|
| 64 |
+
- `/report`:收斂交付、品質門檻與覆蓋度,建議後續。
|
| 65 |
+
- `/dry-run`:僅輸出計畫、將改的檔案與命令清單,不執行。
|
| 66 |
+
- 使用建議:
|
| 67 |
+
- 新任務:先下 `/plan`,確認後 `/propose` → `/apply` → `/test` → `/report`。
|
| 68 |
+
- 若需只看差異:跳到 `/propose`;核准後再 `/apply`。
|
| 69 |
+
- 需要靜態演練:用 `/dry-run`,核准後再 `/apply` 或 `/test`。
|
| 70 |
+
|
| 71 |
+
核准口令
|
| 72 |
+
- 前進:核准、套用、執行、下一步、繼續
|
| 73 |
+
- 調整:退回上一步、只套用 <檔名>、暫停工具呼叫、僅 Dry-run
|
.github/prompts/apply.prompt.md
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# /apply — 實作(審核檢查點 3/5)
|
| 2 |
+
|
| 3 |
+
目的
|
| 4 |
+
- 依 `/propose` 的核准方案,最小變更地修改檔案並即時驗證(build/compile/test)。
|
| 5 |
+
|
| 6 |
+
請輸出與行為
|
| 7 |
+
- 逐檔案套用變更;每檔案變更後,快速檢查語法/型別錯誤。
|
| 8 |
+
- 僅做核准範圍內的修改;任何額外變更需退回 `/propose`。
|
| 9 |
+
- 若遇錯誤,嘗試 1–3 次針對性修正,仍失敗則停下來回報。
|
| 10 |
+
|
| 11 |
+
品質檢查(最少)
|
| 12 |
+
- Build/Lint/Typecheck:PASS/FAIL 摘要(只列異常)。
|
| 13 |
+
- 單元/整合測試:若有,跑最小必要集合;或提供本地冒煙指令與結果概述。
|
| 14 |
+
|
| 15 |
+
守則
|
| 16 |
+
- 僅依核准內容改檔與執行必要驗證;避免重構或格式化無關區塊。
|
| 17 |
+
|
.github/prompts/dry-run.prompt.md
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# /dry-run — 規劃與命令清單(不執行)
|
| 2 |
+
|
| 3 |
+
目的
|
| 4 |
+
- 只產出計畫、將修改的檔案與將執行的命令清單;不改檔、不跑指令。
|
| 5 |
+
|
| 6 |
+
請輸出
|
| 7 |
+
- 計畫摘要與任務拆解
|
| 8 |
+
- 將修改的檔案清單與理由
|
| 9 |
+
- 預計執行的命令(如有)
|
| 10 |
+
- 風險與回滾
|
| 11 |
+
- 等待核准訊息(例如:回覆「執行」)
|
| 12 |
+
|
.github/prompts/plan.prompt.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# /plan — 規劃階段(審核檢查點 1/5)
|
| 2 |
+
|
| 3 |
+
目的
|
| 4 |
+
- 輸出一個可審核的計畫草案,不做任何檔案修改或指令執行。
|
| 5 |
+
- 對齊本倉庫 `docs/spec.md` 的不變條件與契約,特別注意:100 Hz、30s 窗口、<=25 站、Z 代 NE、Vs30 降級、地圖 800px、CSV 欄位約束。
|
| 6 |
+
|
| 7 |
+
輸入(由提問者提供)
|
| 8 |
+
- 需求描述或問題背景。
|
| 9 |
+
- 目標與範圍(如未提供,請以合理假設補齊,並明示)。
|
| 10 |
+
|
| 11 |
+
請輸出(僅限文字,禁止改檔或跑命令)
|
| 12 |
+
- 簡短前置:需求重述與關鍵假設(若有)。
|
| 13 |
+
- Checklist(最多 7 項):
|
| 14 |
+
- 要做的子任務(小而可驗收),每項附驗收標準。
|
| 15 |
+
- 依序標注:Plan→Propose→Apply→Test→Report 對應到哪些子任務。
|
| 16 |
+
- Invariants 對齊:逐條列出是否受影響(Done/Not Impacted/At Risk)。
|
| 17 |
+
- 風險與回滾:主要風險、緩解、回滾方式(最小可逆)。
|
| 18 |
+
- 冒煙測試:2–4 個步驟,含預期輸出要點。
|
| 19 |
+
- 等待核准訊息:請明示「回覆『核准』或指出需調整的項目」。
|
| 20 |
+
|
| 21 |
+
守則
|
| 22 |
+
- 不呼叫任何工具或修改檔案。
|
| 23 |
+
- 若需求可能影響公共行為或 I/O shape,必須標註需先更新 `docs/spec.md`。
|
| 24 |
+
|
.github/prompts/propose.prompt.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# /propose — 變更提案(審核檢查點 2/5)
|
| 2 |
+
|
| 3 |
+
目的
|
| 4 |
+
- 先提出變更方案與差異點,暫不改檔或跑命令。
|
| 5 |
+
|
| 6 |
+
請輸出(僅限文字)
|
| 7 |
+
- 受影響檔案清單(相對路徑)。
|
| 8 |
+
- 每個檔案的具體變更點(項目化說明,不貼整段程式碼),含:
|
| 9 |
+
- 變更位置(符號/區塊/行為)
|
| 10 |
+
- 修改前後行為摘要
|
| 11 |
+
- 風險與回滾(若無則寫「低」)
|
| 12 |
+
- 品質門檻:
|
| 13 |
+
- Build/Lint 風險
|
| 14 |
+
- I/O shape 或 UI 行為是否改變
|
| 15 |
+
- 降級策略與 log 是否覆蓋
|
| 16 |
+
- 等待核准訊息:明確寫「請回覆『套用』或指出需調整的部分」。
|
| 17 |
+
|
| 18 |
+
守則
|
| 19 |
+
- 不呼叫任何工具或修改檔案。
|
| 20 |
+
- 若涉及公共契約,先回到 `/plan` 調整規劃並標註 spec 更新。
|
| 21 |
+
|
.github/prompts/report.prompt.md
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# /report — 總結與交付(審核檢查點 5/5)
|
| 2 |
+
|
| 3 |
+
目的
|
| 4 |
+
- 收斂本次變更的交付物、品質狀態與後續建議。
|
| 5 |
+
|
| 6 |
+
請輸出
|
| 7 |
+
- 變更摘要(對照 `docs/task.md` 與 `change-log.md`)
|
| 8 |
+
- 品質門檻:Build/Lint/Test 狀態(PASS/FAIL)
|
| 9 |
+
- Requirements coverage:對照不變條件與需求,標記 Done/Deferred(含原因)
|
| 10 |
+
- 冒煙測試成果重點
|
| 11 |
+
- 建議的後續工作與風險
|
| 12 |
+
|
.github/prompts/test.prompt.md
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# /test — 測試與驗收(審核檢查點 4/5)
|
| 2 |
+
|
| 3 |
+
目的
|
| 4 |
+
- 驗證功能與邊界;確保降級與 log 符合 `docs/spec.md`。
|
| 5 |
+
|
| 6 |
+
請輸出與行為
|
| 7 |
+
- 執行最小可行測試集或手動冒煙步驟;在必要時提供命令。
|
| 8 |
+
- 列出:
|
| 9 |
+
- 測試案例(Happy path + 邊界 1–2 項)
|
| 10 |
+
- 結果摘要(PASS/FAIL)與關鍵輸出/截圖要點
|
| 11 |
+
- 若 FAIL:列出根因假設與下一步(回 `/apply` 或 `/propose`)
|
| 12 |
+
|
| 13 |
+
守則
|
| 14 |
+
- 僅做與本任務相關的測試;不要擴大範圍。
|
| 15 |
+
|