diff --git a/AGENTS.md b/AGENTS.md index f15ccc2..eb7df0b 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,6 +1,6 @@ # jsc-review — 給 AI 助理的指引 -本 repo 是 jsc 技能組的 `review` domain(程式碼審查:Refactoring 壞味道六組 + 註解規範 + 淺模組),可同時被 Claude Code / Codex / Copilot / Antigravity / Kiro 使用。 +本 repo 是 jsc 技能組的 `review` domain(程式碼審查:Refactoring 壞味道六組、註解規範、淺模組),可同時被 Claude Code / Codex / Copilot / Antigravity / Kiro 使用。 ## 規則 diff --git a/README.md b/README.md index 70c2100..dffc6f7 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Marketplace 統一為 `jsc`(https://gitea.jsc.idv.tw/plugins/jsc.git),安 ### `code-review` -對 git diff 進行六組壞味道審查,每組一個 sub agent 平行執行;回報 `檔案:行號` + 嚴重度 + 建議重構手法,修正與否由呼叫端決定。安全性與 bug 審查交給 CLI 內建 review,不重複。 +對 git diff 進行六組壞味道審查,每組一個 sub agent 平行執行;回報 `檔案:行號`、嚴重度、建議重構手法,修正與否由呼叫端決定。安全性與 bug 審查交給 CLI 內建 review,不重複。 diff --git a/references/smells.md b/references/smells.md index 5d8abfc..4e1bc54 100644 --- a/references/smells.md +++ b/references/smells.md @@ -26,7 +26,7 @@ ### 1.4 基本型態偏執(Primitive Obsession) -- **定義**:不用物件包裝,全部用字串或數字代替(金額、電話、狀態碼、範圍…)。 +- **定義**:不用物件包裝,全部用字串或數字代替(金額、電話、狀態碼、範圍等)。 - **偵測訊號**:以 string/int 表達有格式或規則的概念;同一組基本型態欄位在多處一起出現;以字串常數當型別碼;到處重複的驗證邏輯。 - **建議重構手法**:Replace Primitive with Object、Replace Type Code with Subclasses、Introduce Parameter Object、Extract Class。 @@ -117,7 +117,7 @@ - **定義**:每個公開方法要有一句話描述,並標明所屬層級:**顯示層 / 邏輯層 / 存取層**。 - **偵測訊號**:公開方法無描述;描述未標層級;描述與方法實際行為不符。 -- **建議重構手法**:補上單句描述 + 層級標記;若一個方法橫跨多層,先依 Split Phase 拆分再各自標註。 +- **建議重構手法**:補上單句描述與層級標記;若一個方法橫跨多層,先依 Split Phase 拆分再各自標註。 ### 5.2 輸入參數說明