程式碼審查助手
語言: English | 繁體中文
⚠️ 狀態:參考用(非可執行流程) — 程式碼審查流程協調(4 步驟序列、outcome gating)已於 2026-04-28 移至 adoption layer(XSPEC-095)。此處保留 8 大審查類別定義、BLOCKING/IMPORTANT/SUGGESTION/QUESTION/NOTE 前綴語意供參考;需要強制執行的流程請改用你的 adoption layer 工具鏈。
使用標準化的檢查清單和評論前綴,執行系統性的程式碼審查。
工作流程
- 識別變更 - 透過
git diff或git show取得待審查檔案的差異 - 套用檢查清單 - 系統性地檢查每個審查類別
- 產生報告 - 使用標準評論前綴輸出發現
- 總結 - 提供整體評估和建議的後續行動
審查類別
- 功能性 - 功能是否正確? | Does it work correctly?
- 設計 - 架構是否合適? | Is the architecture appropriate?
- 品質 - 程式碼是否乾淨可維護? | Is the code clean and maintainable?
- 可讀性 - 是否容易理解? | Is it easy to understand?
- 測試 - 測試覆蓋是否足夠? | Is there adequate test coverage?
- 安全性 - 是否有安全漏洞? | Are there any vulnerabilities?
- 效能 - 是否有效率? | Is it efficient?
- 錯誤處理 - 錯誤處理是否妥當? | Are errors handled properly?
評論前綴
| 前綴 | 意義 | 動作 | Action |
|---|---|---|---|
| BLOCKING | 必須在合併前修復 | 必須修復 | Required |
| IMPORTANT | 應該修復 | 建議修復 | Recommended |
| SUGGESTION | 錦上添花 | 可選改善 | Optional |
| QUESTION | 需要說明 | 需要討論 | Discuss |
| NOTE | 資訊性 | 僅供參考 | FYI |
使用方式
/code-review- 審查目前分支的所有變更/code-review src/auth.js- 審查特定檔案/code-review feature/login- 審查特定分支
下一步引導
/code-review 完成後,AI 助手應建議:
程式碼審查完成。建議下一步:
- 有 ❗ BLOCKING 項目 → 修復後重新執行
/code-review- 全部通過 → 執行
/checkin品質關卡- 僅有 💡 SUGGESTION → 執行
/commit提交變更- 審查中發現規範不實用或缺失 → 執行
/audit --report回報
參考
- Pre-Commit Checklist(提交前檢查清單) — 提交之前當作最後一道檢查時讀它。
- 詳細指南:guide.md
- 核心規範:code-review-checklist.md