jimmy60504 commited on
Commit
9ad9330
·
1 Parent(s): 7e26789

docs: update project prompt titles for clarity and consistency

Browse files
.github/copilot-instructions.md CHANGED
@@ -18,7 +18,6 @@
18
  - UI 行為:UI 顯示警告與提示的判準來自 spec;UI 不做字串解析以偷渡參數,不將關鍵參數藏於顯示名稱中。
19
  - 外部資源與預設:對外部依賴(檔案、API、模型、地圖資源)提供預設值、快取與退回路徑,並記錄使用情況與原因。
20
  - 相容性優先:新增或變更功能時,優先保持向後相容;若必須變更公共行為或 I/O,先在 spec 說明,並準備遷移與回滾。
21
- - 測試與驗收:對邊界情境(輸入不足、資料缺失、逾時、格式錯誤)至少提供冒煙測試或最小可驗證步驟,並在 PR 說明列出。
22
  - 原則性限制(抽象):批次處理、長度/頻率/資源上限等僅在 spec 定義;本文件僅要求「遵循 spec 的限制」,不重複具體數值。
23
 
24
  程式碼風格與作法
@@ -39,21 +38,20 @@
39
  提交前檢查(最低需求)
40
  - 是否符合 `spec/spec.md` 的輸入/輸出 shape 與不變條件?
41
  - 針對 spec 中定義的邊界情境(如輸入不足、資料缺失、逾時、格式錯誤等)是否提供冒煙測試或最小驗證步驟?
42
- - Log 是否清楚易懂,足以追蹤降級與邊界情境?
43
 
44
  任務工作流:spec/task.md(跨對話沿用)
45
  - 在規劃或討論變更時,請於 `spec/task.md` 維護任務(提供模板)。
46
  - 每個任務請填寫:背景與目標、不變條件對齊、任務拆解(可勾選)、測試與驗收、降級策略、進度紀錄。
47
  - 子任務應小而可驗收(理想 1 小時內完成),並附明確驗收標準與冒煙測試方式。
48
- - 若變更公共行為或 I/O shape,先更新 `spec/spec.md`,同時在 `spec/task.md` 標註風險回滾策略。
49
- - 建議以 `feature/T-<YYYYMMDD>-<shortname>` 建分支PR 題以 `T-<YYYYMMDD>-<shortname>` 起首;在提交訊息引用任務 ID
50
  - 本工作流僅為協助追蹤,不取代 `spec/spec.md` 的契約約束。
51
 
52
  完成後的變更摘要與 task 重置
53
  - 當某個任務或一批變更完成時,請在 `change-log.md` 新增一個條目,摘要說明本次改變了什麼(可跨多個 Task 合併記錄,非一對一)。
54
  - 條目建議包含:Highlights、Spec/契約影響、行為或 I/O 變更、資料檔影響、降級與 Logging、測試與驗收、風險與回滾、連結(PR/Commits/Task IDs)。
55
  - 條目完成後,可刪除或重置 `spec/task.md`;下次任務開始時請以 `spec/task-template.md` 重新建立。
56
-
57
  ---
58
 
59
  Copilot Slash Commands(審核檢查點工作流)
 
18
  - UI 行為:UI 顯示警告與提示的判準來自 spec;UI 不做字串解析以偷渡參數,不將關鍵參數藏於顯示名稱中。
19
  - 外部資源與預設:對外部依賴(檔案、API、模型、地圖資源)提供預設值、快取與退回路徑,並記錄使用情況與原因。
20
  - 相容性優先:新增或變更功能時,優先保持向後相容;若必須變更公共行為或 I/O,先在 spec 說明,並準備遷移與回滾。
 
21
  - 原則性限制(抽象):批次處理、長度/頻率/資源上限等僅在 spec 定義;本文件僅要求「遵循 spec 的限制」,不重複具體數值。
22
 
23
  程式碼風格與作法
 
38
  提交前檢查(最低需求)
39
  - 是否符合 `spec/spec.md` 的輸入/輸出 shape 與不變條件?
40
  - 針對 spec 中定義的邊界情境(如輸入不足、資料缺失、逾時、格式錯誤等)是否提供冒煙測試或最小驗證步驟?
 
41
 
42
  任務工作流:spec/task.md(跨對話沿用)
43
  - 在規劃或討論變更時,請於 `spec/task.md` 維護任務(提供模板)。
44
  - 每個任務請填寫:背景與目標、不變條件對齊、任務拆解(可勾選)、測試與驗收、降級策略、進度紀錄。
45
  - 子任務應小而可驗收(理想 1 小時內完成),並附明確驗收標準與冒煙測試方式。
46
+ - 每個任務請填寫:背景目標、不變條件對齊、任務拆解(可勾選)、降級策略、進度紀錄
47
+ - 子任務應小而可驗收(理想 1 小時內完成)並附明確驗收
48
  - 本工作流僅為協助追蹤,不取代 `spec/spec.md` 的契約約束。
49
 
50
  完成後的變更摘要與 task 重置
51
  - 當某個任務或一批變更完成時,請在 `change-log.md` 新增一個條目,摘要說明本次改變了什麼(可跨多個 Task 合併記錄,非一對一)。
52
  - 條目建議包含:Highlights、Spec/契約影響、行為或 I/O 變更、資料檔影響、降級與 Logging、測試與驗收、風險與回滾、連結(PR/Commits/Task IDs)。
53
  - 條目完成後,可刪除或重置 `spec/task.md`;下次任務開始時請以 `spec/task-template.md` 重新建立。
54
+ - 條目建議包含:Highlights、Spec/契約影響、行為或 I/O 變更、資料檔影響、降級與 Logging、風險與回滾、連結(PR/Commits/Task IDs)。
55
  ---
56
 
57
  Copilot Slash Commands(審核檢查點工作流)
.github/prompts/project.apply.prompt.md CHANGED
@@ -1,4 +1,4 @@
1
- # /project.apply — 選擇與啟動任務(審核檢查點 2.5/5)
2
 
3
  目的
4
  - 根據使用者在 `/project.task` 中的選擇,更新 `spec/task.md` 的 checklist。
 
1
+ # /project.apply — 選擇與啟動任務
2
 
3
  目的
4
  - 根據使用者在 `/project.task` 中的選擇,更新 `spec/task.md` 的 checklist。
.github/prompts/project.plan.prompt.md CHANGED
@@ -1,4 +1,4 @@
1
- # /project.plan — 規劃階段(審核檢查點 1/5)
2
 
3
  目的
4
  - 產生 `spec/plan.md`:定義本次 sprint 的範圍、目標與驗收標準,讓使用者能在討論階段進行修改。
 
1
+ # /project.plan — 規劃階段
2
 
3
  目的
4
  - 產生 `spec/plan.md`:定義本次 sprint 的範圍、目標與驗收標準,讓使用者能在討論階段進行修改。
.github/prompts/project.report.prompt.md CHANGED
@@ -1,4 +1,4 @@
1
- # /project.report — 總結與交付(審核檢查點 3/3)
2
 
3
  目的
4
  - 收斂本次變更的交付物、品質狀態與後續建議。
@@ -8,10 +8,11 @@
8
  - **變更摘要**(對照 `spec/task.md` 與 `spec/plan.md`)
9
  - **品質門檻**:Build/Lint 狀態、I/O 契約驗證、降級與 logging 覆蓋
10
  - **Requirements coverage**:對照 `spec/spec.md` 的不變條件與需求,標記 Done/Deferred(含原因)
11
- - **冒煙測試成果**:根據 spec/plan.md 定義冒煙測試結果
12
  - **建議的 change-log 條目**:格式符合 change-log.md 的記錄標準
13
  - **後續建議**:風險、後續工作、優化空間
14
 
15
  守則
16
- - 不做檔案修改;由使用者根據報告內容手動更新 `change-log.md`。
 
17
  - 完成後提示使用者本次 sprint 交付狀態與下一步建議。
 
1
+ # /project.report — 總結與交付
2
 
3
  目的
4
  - 收斂本次變更的交付物、品質狀態與後續建議。
 
8
  - **變更摘要**(對照 `spec/task.md` 與 `spec/plan.md`)
9
  - **品質門檻**:Build/Lint 狀態、I/O 契約驗證、降級與 logging 覆蓋
10
  - **Requirements coverage**:對照 `spec/spec.md` 的不變條件與需求,標記 Done/Deferred(含原因)
11
+ - **使用者體驗變更檢查**:若涉及 UI 行為、功能說明、輸入選項或操作流程的改變,列出需要更新 README 的項目(例如新增欄位、UI 互動邏輯變更、新功能說明等),並提示使用者需同步更新 `README.md`「主要功能」或「快速開始」等相關章節
12
  - **建議的 change-log 條目**:格式符合 change-log.md 的記錄標準
13
  - **後續建議**:風險、後續工作、優化空間
14
 
15
  守則
16
+ - 不做檔案修改;由使用者根據報告內容手動更新 `change-log.md` 與 `README.md`
17
+ - 若有 UX 變更,明確提示使用者需要更新 README 的具體章節與內容。
18
  - 完成後提示使用者本次 sprint 交付狀態與下一步建議。
.github/prompts/project.task.prompt.md CHANGED
@@ -1,4 +1,4 @@
1
- # /project.task — 任務清單(審核檢查點 2/5)
2
 
3
  目的
4
  - 根據 `spec/plan.md` 和 `spec/task.md`,列出本 sprint 的編號 task 清單,讓使用者檢查、調整、增減。
 
1
+ # /project.task — 任務清單
2
 
3
  目的
4
  - 根據 `spec/plan.md` 和 `spec/task.md`,列出本 sprint 的編號 task 清單,讓使用者檢查、調整、增減。