Files
shared/templates/readme-passthrough-sections.md
T
jiantw83andClaude Sonnet 5 1030f9d403 feat(shared): 新增14個共用spec、models/todo工具與樣板產生器,收斂跨repo重複規範
依 todo.md 執行的規範治理專案:新增 spec-preflight 等 14 個共用規範(含
conventional-commit/pull-request/git-push/issue-read/todo-list/ask-user/
subagent/no-scratch-files/skill-invocation/script-path/action-scaffold/
node-src-layout/plugin-cli/model),擴充 spec-git-safety 與 spec-gitea(token
優先序、機密遮蔽、Wiki 頁名轉義規則);新增可執行 skill `models`(模型能力
查詢與標籤)與 `todo`(依指定模型產生/附加 todo.md);新增 plugin.meta.json
單一事實來源與 gen-plugin-files.mjs 樣板產生器,統一四個 repo 的 manifest/
README/AGENTS.md 並移除寫死的本機使用者路徑;新增 shared/scripts/lib 的
log/機密遮蔽三語言參考實作。

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-08-11 06:02:30 +00:00

20 lines
2.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# README 共通章節樣板說明 — passthrough 類
`gen-plugin-files.mjs` 對 README.md 的五個共通章節中,以下三節目前**只重新包裝標記、內容原樣保留**(不做內容轉換),因為這三節的內文本質是各 repo 特有事實(skills 清單、目錄樹、範例指令),沒有可安全泛化的共同結構;改為由產生器在目標 repo 現有 README.md 中就地讀出整節內容,重新包在同一個章節標題下寫回,藉此仍納入「產生器管理範圍」(未來要調整寫法時,只要改產生器的抽取/重寫邏輯,不必手動改四份 README),同時保證這一步 dry-run 不會顯示非預期差異。
## 章節與標題(標記=標題本身)
| 章節 | 標題文字(預設) | 備註 |
| --- | --- | --- |
| 目錄結構 | `## 目錄結構` | 含目錄樹 code block 與任何附帶的 blockquote/子章節,四個 repo 皆同標題 |
| 用 CLI 直接執行 skill | `## 用 CLI 直接執行 skill(headless / 一次性)` | 四個 repo 皆同標題 |
| 新增一個 skill | `## 新增一個 skill` 或 `## 新增/修改 skill` | persona 用「新增/修改 skill」,其餘三個 repo 用「新增一個 skill」;標題文字存在 `plugin.meta.json` 的 `readmeHeadings.addSkill`(省略則預設「新增一個 skill」) |
## 抽取規則
一個章節的範圍 = 從標題行開始,到下一個獨立一行的 `---` 分隔線(不含)或下一個 `## ` 標題(不含)或檔尾,取先到者。抽取後原樣寫回同一位置;只要來源 README 這三節目前的內容本身不變,dry-run 就不會顯示差異。
## 何時需要真正改寫
若某個 repo 這三節的內容需要實質變更(例如新增/刪除一個 skill 導致目錄樹要更新),仍照舊由人工編輯該 repo 的 README.md(`funcs`/`新增一個 skill` 流程本來就是手動維護這幾節);產生器目前的職責只是「安裝章節精簡+manifest/AGENTS.md 一致性」,不接管這三節的實質內容維護。