plugins/review
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(review): 技能與說明文件納入文件編號夾帶審查

Browse Source 
What：skills/code-review/SKILL.md 的第 2 組 Obscurity 審查範圍納入 2.5，
Notes 補上與 jsc-hooks 的 comment-scope.sh 分工說明；README.md 的技能說明
與參考檔表格同步。

Why：規則正文放進 references 還不夠，sub agent 讀的是 SKILL.md 的審查範圍表。
範圍表沒寫，第 2 組就不會查這一項。使用者讀的是 README.md，參考檔沒列出來就找不到。

How：審查範圍表的第 2 組直接列出六類命中樣式，並指向 references/comment-scope.md
取完整清單。Notes 寫明 comment-scope.sh 負責樣式判定得了的項目，第 2 組負責
樣式判定不了的專案代號與客戶名稱，兩邊不重複回報。README.md 表格新增一列。

Who：jsc-review 的 code-review 技能與存取庫說明文件。
This commit is contained in:
jiantw83
2026-08-26 19:00:38 +08:00
parent fd70ce3bc2
commit df81eec8fb
2 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2 -1
View File
@@ -26,7 +26,7 @@ Marketplace 統一為 `jsc`（https://gitea.jsc.idv.tw/plugins/meta.git），安
### `code-review` ### `code-review`
對 git diff 進行六組壞味道審查，每組一個 sub agent 平行執行；回報 `檔案:行號`、嚴重度、建議重構手法，修正與否由呼叫端決定。diff 是空的就直接回報「無發現」，不開任何 sub agent；六組全部回覆才進入彙整，沒東西可報的那組也要回「無發現」。安全性與 bug 審查交給 CLI 內建 review，不重複。 對 git diff 進行六組壞味道審查，每組一個 sub agent 平行執行；回報 `檔案:行號`、嚴重度、建議重構手法，修正與否由呼叫端決定。第 2 組同時擋「文件編號夾帶」：註解只寫「為什麼這樣寫」，議題編號、wiki 頁編號、工作包編號、commit hash、`@` 提及、外部文件連結一律不進註解，清單看 `references/comment-scope.md`。diff 是空的就直接回報「無發現」，不開任何 sub agent；六組全部回覆才進入彙整，沒東西可報的那組也要回「無發現」。安全性與 bug 審查交給 CLI 內建 review，不重複。
<!-- JSC-SKILLS:END --> <!-- JSC-SKILLS:END -->
@@ -35,6 +35,7 @@ Marketplace 統一為 `jsc`（https://gitea.jsc.idv.tw/plugins/meta.git），安
| 檔案 | 用途 | | 檔案 | 用途 |
| --- | --- | | --- | --- |
| `references/smells.md` | 六組壞味道完整清單：定義、偵測訊號、建議重構手法、嚴重度分級；範例資料必須去識別化 | | `references/smells.md` | 六組壞味道完整清單：定義、偵測訊號、建議重構手法、嚴重度分級；範例資料必須去識別化 |
| `references/comment-scope.md` | 程式碼註解內容界線：禁止寫進註解的文件編號清單、允許項目與白名單、命中時的改法 |
## 相關 domain ## 相關 domain
skills/code-review/SKILL.md
+2 -1
View File
@@ -25,7 +25,7 @@ Review changed code against `references/smells.md` (from the book *Refactoring*)
| Group | Scope | | Group | Scope |
| --- | --- | | --- | --- |
| 1 Bloaters | smells.md group 1 | | 1 Bloaters | smells.md group 1 |
| 2 Obscurity | smells.md group 2 | | 2 Obscurity | smells.md group 2, including 2.5 document reference leak — comments carrying issue ids, wiki page ids, work package ids, commit hashes, @ mentions, or external document links; the full banned and allowed lists live in `references/comment-scope.md` |
| 3 Couplers | smells.md group 3 | | 3 Couplers | smells.md group 3 |
| 4 Dispensables & Others | smells.md group 4 | | 4 Dispensables & Others | smells.md group 4 |
| 5 Comment contract | smells.md group 5 | | 5 Comment contract | smells.md group 5 |
@@ -39,5 +39,6 @@ Review changed code against `references/smells.md` (from the book *Refactoring*)
## Notes ## Notes
- `jsc-hooks`' `comment-scope.sh` already matches the pattern-detectable items after every file write. Group 2 here covers what patterns cannot decide — project code names and customer names — plus the overall judgment; the two never report the same finding twice.
- If group 5 examples are fetched from a database, they must be de-identified; never include personal data. - If group 5 examples are fetched from a database, they must be de-identified; never include personal data.
- When there are no findings, report the literal 「無發現」 explicitly; never leave the report empty. - When there are no findings, report the literal 「無發現」 explicitly; never leave the report empty.