Community寫作與編輯github.com

AnjanJ/shipkit

用 Claude 寫出更好的程式碼。為 Claude Code 提供的技能、代理、規則與知識庫。鏡像自 codeberg.org/AnjanJ/shipkit。

shipkit 是什麼?

此技能為 Claude Code 導入了一個結構化的 QA 工作流程,名為 `/qa`,旨在對近期變更或特定檔案進行全面的品質保證。其獨特之處在於完全在 Claude Code 的內聯環境中執行,而非以分叉(fork)技能執行,因為第二階段的提問與第三階段的計畫審核需要使用 AskUserQuestion 工具,而分叉技能無法使用此工具。對於大型變更集,它建議將第一階段的識別工作委派給 codebase-explorer 代理,以節省主上下文空間。該技能分為五個階段:識別(檢測測試框架、根據風險分類檔案)、審問(提出聚焦於風險的探查問題)、測試計畫(以表格形式呈現結構化計畫並等待批准)、規格撰寫(遵循單一斷言、描述性名稱、Arrange-Act-Assert 結構等原則),以及執行與驗證(運行測試、修復失敗、產生包含判決的 QA 報告)。它支援多種測試框架,如 RSpec、Minitest、ExUnit、Jest、Vitest 與 Playwright。

相容平台✓Claude Code~Codex CLI~Cursor
npx skills add AnjanJ/shipkit

Installed? Explore more 寫作與編輯 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

在你喜歡的 AI 中提問

開啟一個已預先載入此 Agent Skill 的新對話。

說明文件

/qa — 品質保證工作流程

執行此技能以對近期變更或特定檔案進行完整的 QA。

近期變更的檔案

!git diff --name-only HEAD~1 2>/dev/null | head -20 || echo "未偵測到近期變更"

第一階段:識別

  1. 偵測測試框架,檢查以下項目:
    • Gemfile 中包含 rspec/minitest → RSpec 或 Minitest
    • mix.exs → ExUnit
    • package.json 中包含 jest/vitest → Jest 或 Vitest
    • playwright.config → Playwright
  2. 識別已變更的檔案 — 如果 $ARGUMENTS 是檔案路徑,則使用該路徑;否則執行 git diff --name-only HEAD~1
  3. 分類每個檔案,根據風險級別:
    • 嚴重:驗證、金流、資料模型、共用工具、API 端點
    • 高:商業邏輯、服務、控制器
    • 中:檢視、序列化器、輔助工具、設定
    • 低:文件、註解、格式化
  4. 讀取每個已變更的檔案及其現有測試(如有)。如果變更的檔案超過約 5 個, 請將此讀取工作委派給 codebase-explorer 代理,並根據其摘要進行後續工作 — 保留主上下文用於問題與測試。
  5. 建立上下文表格:
檔案類型風險已有測試?
............

第二階段:審問

在撰寫任何測試之前,使用 AskUserQuestion 提出 3 到 8 個探查問題。 請分組提問 — 不要一次只問一個。

好的問題(聚焦風險):

  • "這涉及金流流程 — 我應不應該測試退款邊界案例?"
  • "新的驗證機制拒絕空白輸入。那僅含 unicode 字元的字串呢?"
  • "這個服務呼叫了外部 API — 我應該模擬它還是測試整合?"

不好的問題(不要問這些):

  • "這段程式碼是做什麼的?"(請自己閱讀)
  • "我應該寫測試嗎?"(是的,永遠都要)
  • "我應該使用哪個測試框架?"(請自行偵測)

第三階段:測試計畫

在撰寫任何規格之前,提出結構化的測試計畫。 按類別組織:

測試類別

  1. 快樂路徑 — 預期的輸入產生預期的輸出
  2. 邊界案例 — 邊界值、空白輸入、最大值、nil/null
  3. 錯誤案例 — 無效輸入、網路故障、超時、權限拒絕
  4. 奇怪/對抗性 — SQL 注入字串、腳本標籤、表情符號、10MB 字串、並發存取
  5. 效能 — N+1 查詢、無邊界集合、慢查詢(僅限嚴重/高風險)
  6. 整合 — 元件之間的互動(僅當多個檔案變更時)

以表格呈現:

#類別測試描述風險級別
1快樂路徑使用有效參數建立記錄高
............

等待使用者核准後再繼續。

第四階段:規格撰寫

依照以下模式撰寫規格:

  • 每個測試一個斷言(在可行情況下)
  • 描述性名稱 — it "在找不到記錄時回傳 404" 而非 it "有效"
  • 安排-行動-斷言結構
  • 無神秘嘉賓 — 所有測試資料在測試中都可見
  • 測試行為,而非實作 — 不要直接測試私有方法
  • 使用適當的工廠/固定資料,依框架而定
  • 按行為分組,使用 describe/context 區塊

測試程式碼品質

測試也是程式碼 — 套用相同原則:

  • KISS: 不要過度設計測試輔助工具。如果設定超過 10 行,請簡化測試或受測程式碼。
  • YAGNI: 不要測試不可能發生的情境。不要為了「以防萬一」而針對不可能的狀態加入測試。
  • DRY(有所節制): 偏好清楚的程式碼重複,勝過聰明的共用範例。一個測試應該能從頭到尾閱讀,而不需要跳到 3 個輔助檔案。
  • 整潔程式碼: 描述性的測試名稱,讀起來就像文件。無神秘嘉賓 — 所有資料在測試中都可見。

請參閱 @reference.md 取得框架特定的測試注意事項(RSpec、Minitest、ExUnit、Jest/Vitest)。

第五階段:執行與驗證

  1. 運行新的規格 — 目標性運行(僅新的檔案)
  2. 修復任何失敗 — 讀取錯誤、讀取程式碼、修正根本原因
  3. 運行完整測試套件 — 確保沒有破壞其他功能
  4. 產生 QA 報告 — 請參閱 @reference.md 取得報告範本、核心價值審核與合理化檢查。

判決: 可以出貨 / 修正後重新測試 / 需要重做

相關技能