feat/comment-scope-rule #8

Merged
admin merged 3 commits from feat/comment-scope-rule into develop 2026-08-27 00:56:41 +00:00
3 Commits
Author SHA1 Message Date
jiantw83 0df99db512 feat(review): 三份 manifest 同步升版至 0.0.5
What:plugin.json、.claude-plugin/plugin.json、.codex-plugin/plugin.json
三份 manifest 的 version 由 0.0.4 改為 0.0.5。

Why:本次新增了註解內容界線規則,屬於功能異動。版本沒跟著升,各 CLI 端的
外掛版本護欄就分不出新舊,已安裝的使用者也收不到更新。

How:三份 manifest 只改 version 欄位,其餘欄位維持原樣,三處版本號保持一致。

Who:jsc-review 外掛的安裝與更新流程。
2026-08-26 19:00:38 +08:00
jiantw83 df81eec8fb feat(review): 技能與說明文件納入文件編號夾帶審查
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 技能與存取庫說明文件。
2026-08-26 19:00:38 +08:00
jiantw83 fd70ce3bc2 feat(review): 新增程式碼註解禁止夾帶文件資訊的規則正文
What:新增 references/comment-scope.md 規則正文,並在 references/smells.md
第 2 組加入 2.5 文件編號夾帶,嚴重度分級「低」列補上本項。

Why:註解寫「這件事記在哪份文件」,讀程式碼的人查不到。編號會過期、會搬家、
會落在存取權限外,最後只剩一串無意義的代號。註解該寫的是「為什麼這樣寫」。

How:規則正文限定適用範圍只到程式碼註解,docstring、README、commit 訊息不受限。
禁止清單三十項分四組:追蹤系統編號、jsc wiki 頁面編號、需求與規格編號、
流程與人事資訊。白名單七項:日期與時間戳、需求變更歷程、RFC 與 ISO 標準、CVE、
第三方套件 issue 連結、授權標頭與 SPDX、語言原生標記。

Who:jsc-review 的 code-review 技能,第 2 組可讀性審查。
2026-08-26 19:00:38 +08:00