docs(README): 前置需求分開講安裝與跑流程,並把指令是否真的跑得動釘住
前置需求表原本一句「缺少時腳本印出指引並中止」套在所有需求上,但 install 只 警告不中止——文件描述的是一個不存在的行為。改成逐項寫「缺了會怎樣」,並把 「安裝只需要 Node」提到表前面:使用者不該為了裝 plugin 先去裝 tea。 另外補上三條把 #30 驗收標準真的驗起來的測試。其中一條把 README bash 區塊裡的 tea-sdlc 指令逐行拿去真的執行(家目錄指向空的暫存,所以一個檔都不會寫), 失敗理由若是「這個指令/參數我不認得」就算 README 寫錯——這比用眼睛核對可靠。 議題 #30 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -49,13 +49,16 @@ tea-sdlc/
|
||||
|
||||
## 前置需求
|
||||
|
||||
| 需求 | 用途 | 備註 |
|
||||
安裝與佈署(`tea-sdlc install`)只需要 Node;其餘是**跑流程指令**時才需要的。
|
||||
本工具一律不替你安裝任何東西。
|
||||
|
||||
| 需求 | 用途 | 缺了會怎樣 |
|
||||
| --- | --- | --- |
|
||||
| Node.js ≥ 20 | 執行 `scripts/` 與測試 | 不自動安裝,缺少時腳本印出指引並中止 |
|
||||
| git | 分支與 commit 操作 | 同上 |
|
||||
| [`tea`](https://gitea.com/gitea/tea) 並已登入 | Gitea 議題、標籤、Milestone、留言、工時 | `tea login add` |
|
||||
| 目標 repo 已開啟時間追蹤 | 工時碼錶 | Settings → Advanced Settings → Enable Time Tracker |
|
||||
| 帳號對目標 repo 的 issues unit 有寫入權 | 建立與更新議題 | Gitea 的 unit 權限獨立於 push 權限 |
|
||||
| Node.js ≥ 20 | 執行 `tea-sdlc` 與 `scripts/` | 連 `tea-sdlc` 都跑不起來 |
|
||||
| git | 分支與 commit 操作 | `install` 照樣把轉接檔裝好,只在輸出裡列出缺的東西;流程指令中止並印出安裝指引 |
|
||||
| [`tea`](https://gitea.com/gitea/tea) 並已登入 | Gitea 議題、標籤、Milestone、留言、工時 | 同上;登入用 `tea login add` |
|
||||
| 目標 repo 已開啟時間追蹤 | 工時碼錶 | 流程指令中止,並指出 Settings → Advanced Settings → Enable Time Tracker |
|
||||
| 帳號對目標 repo 的 issues unit 有寫入權 | 建立與更新議題 | 流程指令中止;Gitea 的 unit 權限獨立於 push 權限 |
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user