TTSAM / .github /task-template.md
jimmy60504's picture
docs: simplify spec and task templates for single-project use
8d4cef3
|
raw
history blame
1.79 kB

Task: <標題>

  • Task ID: T--
  • Date:
  • Status: Planning | In Progress | Done

背景與目標

  • 背景:為何需要?與 spec/spec.md 的哪一段相關?
  • 目標:交付物與驗收標準(一句或要點形式)。
  • 不在範圍:明確避免 scope creep。

任務拆解(可勾選)

  • 子任務 1:<描述>(變更檔案:...
    • 驗收:<可驗證的條件>
  • 子任務 2:<描述>(變更檔案:...
    • 驗收:<可驗證的條件>
  • 子任務 3:<描述>(變更檔案:...
    • 驗收:<可驗證的條件>

每個子任務盡量控制在 1 小時內可完成。

不變條件與約束檢查

  • 是否影響 spec/spec.md 中的 I/O shape、欄位、或不變條件?
  • 如是,已更新 spec 並標註破壞性變更?
  • 邊界情境(資料缺漏、外部依賴失敗等)是否正確降級並記錄 log?

填寫相關 spec 章節編號或行號(如 spec #3, #6)。

手動驗收(冒煙測試)

  • 步驟
    1. <步驟 1>
    2. <步驟 2>
    3. <步驟 3>
  • 預期結果:<清楚描述>
  • 失敗情境測試(若適用):<一個邊界案例的驗證步驟>

完成檢查

  • 程式碼符合 spec/spec.md 約束
  • 手動驗收通過
  • 關鍵邊界情況有 log(INFO/WARNING/ERROR)
  • 若改動 CSV 或模型契約,spec 已同步

進度紀錄

  • :<進度更新或決策>

附錄 A:Commit 信息模板

feat(task T-<YYYYMMDD>-<shortname>): <簡述>

- <子任務/變更點 1>
- <子任務/變更點 2>

Refs: T-<YYYYMMDD>-<shortname>

附錄 B:分支/PR 命名

  • 分支:feature/T-<YYYYMMDD>-<shortname>
  • PR 標題:T-<YYYYMMDD>-<shortname>: <簡述>