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

feat/comment-scope-rule #8

Merged
admin merged 2 commits from feat/comment-scope-rule into develop 2026-08-27 00:56:54 +00:00
Conversation 0 Commits 2 Files Changed 5
+6 -3
jiantw83 commented 2026-08-26 11:01:13 +00:00
Member
Copy Link
Copy Source

摘要

  • 需求描述：落地規則「程式碼註解禁止夾帶文件相關資訊」。在 pkg-update 技能與 README.md 加入註解界線指引，規則正文留在 jsc-review 的 references/comment-scope.md，此處不重複清單。
  • 計畫名稱：無
  • 計畫頁：無
  • 分析頁：無

變更內容

檔案 為什麼改
skills/pkg-update/SKILL.md 步驟 3.5 新增註解界線規則：鎖版本與繞道寫法的註解只寫原因、第三方套件 issue 連結屬白名單可以寫、內部議題編號與工作包編號與人名與 @ 提及與產生來源署名不得寫，並附可檢核的完成條件。
README.md pkg-update 說明同步同一份指引，讓讀 README 的人不必先打開技能檔就知道界線。
plugin.json 行為變更需發版，版本由 0.0.5 升為 0.0.6。
.claude-plugin/plugin.json 同上，三份 manifest 版本保持一致。
.codex-plugin/plugin.json 同上，三份 manifest 版本保持一致。

設計重點

  • 規則正文單一來源：清單只留在 jsc-review 的 references/comment-scope.md，本 repo 只放指引與連結，避免兩處清單各自漂移。
  • 白名單講清楚例外：第三方套件的 issue 連結可以寫，因為它同時說明繞道成因與解除條件，正是 pkg-update 最常踩到的情境。
  • 完成條件可檢核：步驟 3.5 要求每一行新增註解都要寫出原因、且不得帶內部議題編號、工作包編號、人名、@ 提及與產生來源署名，並要求把 comment-scope.sh 的告警當場修正後回檢至無告警。
  • 只改文件、不動流程：本次未更動 pkg-update 的任何工具指令、exit code 路由與還原機制。

測試結果

  • meta/tools/ste100-lint.sh 對 README.md：exit 0，無違規。
  • skills/pkg-update/SKILL.md 掃描 CJK 字元：命中 0 行，整份維持英文。
  • skills/pkg-update/SKILL.md 的 frontmatter description：未改動。

前置 Push Request

  • 無
## 摘要 - 需求描述：落地規則「程式碼註解禁止夾帶文件相關資訊」。在 pkg-update 技能與 README.md 加入註解界線指引，規則正文留在 jsc-review 的 `references/comment-scope.md`，此處不重複清單。 - 計畫名稱：無 - 計畫頁：無 - 分析頁：無 ## 變更內容 | 檔案 | 為什麼改 | | --- | --- | | skills/pkg-update/SKILL.md | 步驟 3.5 新增註解界線規則：鎖版本與繞道寫法的註解只寫原因、第三方套件 issue 連結屬白名單可以寫、內部議題編號與工作包編號與人名與 @ 提及與產生來源署名不得寫，並附可檢核的完成條件。 | | README.md | pkg-update 說明同步同一份指引，讓讀 README 的人不必先打開技能檔就知道界線。 | | plugin.json | 行為變更需發版，版本由 0.0.5 升為 0.0.6。 | | .claude-plugin/plugin.json | 同上，三份 manifest 版本保持一致。 | | .codex-plugin/plugin.json | 同上，三份 manifest 版本保持一致。 | ## 設計重點 - 規則正文單一來源：清單只留在 jsc-review 的 `references/comment-scope.md`，本 repo 只放指引與連結，避免兩處清單各自漂移。 - 白名單講清楚例外：第三方套件的 issue 連結可以寫，因為它同時說明繞道成因與解除條件，正是 pkg-update 最常踩到的情境。 - 完成條件可檢核：步驟 3.5 要求每一行新增註解都要寫出原因、且不得帶內部議題編號、工作包編號、人名、@ 提及與產生來源署名，並要求把 `comment-scope.sh` 的告警當場修正後回檢至無告警。 - 只改文件、不動流程：本次未更動 pkg-update 的任何工具指令、exit code 路由與還原機制。 ## 測試結果 - `meta/tools/ste100-lint.sh` 對 `README.md`：exit 0，無違規。 - `skills/pkg-update/SKILL.md` 掃描 CJK 字元：命中 0 行，整份維持英文。 - `skills/pkg-update/SKILL.md` 的 frontmatter `description`：未改動。 ## 前置 Push Request - 無
jiantw83 added 2 commits 2026-08-26 11:01:13 +00:00
feat(pkg-update): 加入註解界線規則與 README 同步說明 992d9c759c 
What：在 pkg-update 技能的步驟 3.5 新增註解界線規則，並在 README.md 的 pkg-update 段落同步同一份指引。

Why：套件更新途中常會為了鎖版本或繞道不相容而留註解，過去沒有界線，容易把文件相關資訊寫進程式碼註解，造成註解與文件重複、且內容很快過期。

How：規則正文留在 jsc-review 的 references/comment-scope.md，這裡只放指引與連結、不重複清單。註解只寫鎖版本或繞道的原因；第三方套件的 issue 連結屬白名單，用來說明繞道成因與解除條件；內部議題編號、工作包編號、人名與 @ 提及、產生來源署名一律不得寫。步驟 3.5 另附可檢核的完成條件，並指向 jsc-hooks 的 comment-scope.sh 即時告警與修正回檢流程。

Who：jsc-pkg 的 pkg-update 技能，以及 README.md 的技能說明區塊。
feat(manifest): 三份 manifest 版本升至 0.0.6 913a51796d 
What：把 plugin.json、.claude-plugin/plugin.json、.codex-plugin/plugin.json 的 version 由 0.0.5 升為 0.0.6。

Why：pkg-update 技能新增註解界線規則，屬於行為變更，必須發版才會被各 CLI 的外掛版本守衛辨識並更新。

How：三份 manifest 同步改動同一個 version 欄位，其餘欄位不動，維持三份內容一致。

Who：jsc-pkg 外掛的三份 manifest。
admin merged commit ce7d6d48a5 into develop 2026-08-27 00:56:54 +00:00
admin deleted branch feat/comment-scope-rule 2026-08-27 00:56:54 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
No items
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
admin (系統管理員) jiantw83 (Jeffery)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: plugins/pkg#8