41 lines
3.7 KiB
Markdown
41 lines
3.7 KiB
Markdown
# tea-sdlc — 以 tea 驅動 SDLC 全流程的跨平台指令組
|
||
|
||
本 repo 提供六個顯式指令（`/sdlc-plan`、`/sdlc-analyze`、`/sdlc-feat`、`/sdlc-fix`、`/sdlc-sync`、`/sdlc-report`），
|
||
把軟體開發流程的各階段固定成可重複的步驟。流程正本只寫一份平台中立 markdown，
|
||
由 `scripts/install.js` 產生 Claude Code、Codex、Antigravity、Copilot、Kiro、oh-my-pi、OpenCode 各自的薄轉接檔。
|
||
|
||
本 repo 以 npm 佈署：`npm i -g <git url>` 裝出 `tea-sdlc` 指令，`tea-sdlc install` 產生各平台轉接檔。
|
||
轉接檔裡沒有路徑，只有一句 `tea-sdlc prompt --name <指令名>`，正本在哪由入口自己回推。
|
||
|
||
> 六個流程正本都到齊了；安裝器佈署的就是 `prompts/` 裡的那六份。進度見
|
||
> [議題 #1](https://gitea.jsc.idv.tw/plugins/tea-sdlc/issues/1) 底下的工作包。
|
||
|
||
## 模組邊界
|
||
|
||
改動時請先確認要動的東西屬於哪一層，不要讓職責外溢到相鄰目錄。
|
||
|
||
| 目錄 | 職責 | 邊界 |
|
||
| --- | --- | --- |
|
||
| `prompts/` | 流程正本（`sdlc-{plan,analyze,feat,fix,sync,report}.md`），唯一的事實來源 | 平台中立 markdown，不含任何平台專屬語法 |
|
||
| `scripts/` | 所有副作用、抽取、schema 驗證與 artifact 產生 | Node、零外部套件，僅用內建 `fetch` / `child_process` / `fs`；HTML、SVG、manifest 與附件生命週期也由此處負責 |
|
||
| `templates/` | Markdown 產出格式（議題、PR、報表） | 以 `{{變數}}` 佔位，不含邏輯；HTML artifact 由 `scripts/overview-render.js` 產生 |
|
||
| `references/` | 規則正本（實作規範、註解格式對照表、可行性檢查清單、委派判準、artifact 契約） | 由流程正本指名讀取，不自行散落於 prompts |
|
||
| `bin/tea-sdlc.js` | 指令入口：取走子指令，其餘 argv 原樣交出去 | 不含任何平台目錄知識，也不自己動手做事 |
|
||
| `scripts/install.js` | 平台偵測與轉接檔產生／移除 | 唯一知道各平台目錄結構的地方 |
|
||
| `scripts/install-verify.js` | 安裝後走一遍叫用鏈（轉接檔 → PATH 上的 tea-sdlc → 流程正本） | 只認拿到的轉接檔路徑，不自己推導平台目錄；不碰網路 |
|
||
| `skills/` | 各助理原生 plugin 機制讀取的 skills | 目前為空；指令以轉接檔形式佈署 |
|
||
|
||
## 慣例
|
||
|
||
- **零外部套件**：`package.json` 不得出現 `dependencies` 或 `devDependencies`。測試用 Node 內建 `node:test` + `node:assert`。
|
||
- **契約以議題為正本**：腳本的 flag 介面、JSON 輸出形狀、前置檢查與路徑定位規則，正本在[議題 #1](https://gitea.jsc.idv.tw/plugins/tea-sdlc/issues/1)，實作時以該處為準；本檔不複寫，以免兩邊走鐘。
|
||
- **測試**：`npm test`（等同 `node --test`）。測試產生的暫存一律寫到 `.tmp/`，該目錄已被 git 忽略，也不會被測試探索掃到。
|
||
- **不改目標專案**：本 plugin 只讀目標專案的程式碼，不寫入目標專案的 `CLAUDE.md` 或任何設定檔。
|
||
唯一的例外是 git 自己的內部中繼資料——`git worktree add` 一定會在目標 repo 的
|
||
`.git/worktrees/` 底下寫東西，那是 git 的機制，無法避免，也不是專案的內容檔。
|
||
- **工作樹集中在家目錄**：每顆工作包的工作樹開在 `~/.tea-sdlc/worktrees/{hash}`，
|
||
路徑由 `owner/repo/分支名` 純函式推導（`scripts/lib.js` 的 `worktreePath`），
|
||
不查表也不寫狀態檔。不開在目標專案裡（會出現在它的 `git status`），
|
||
也不開在它的兄弟目錄（那個目錄結構屬於使用者）。
|
||
- **不自動觸發**：所有指令僅由使用者明確叫用；skill/command 的 `description` 統一以「僅由 /sdlc-xxx 指令叫用。」起頭。
|