lee-spec-kit 0.6.15 โ 0.6.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.en.md +85 -11
- package/README.md +87 -11
- package/dist/index.js +668 -43
- package/package.json +1 -1
- package/templates/en/common/README.md +24 -0
- package/templates/en/common/agents/agents.md +1 -1
- package/templates/en/common/agents/skills/create-pr.md +4 -2
- package/templates/en/common/features/feature-base/issue.md +3 -7
- package/templates/en/common/features/feature-base/pr.md +3 -3
- package/templates/ko/common/README.md +24 -0
- package/templates/ko/common/agents/agents.md +1 -1
- package/templates/ko/common/agents/skills/create-pr.md +4 -2
- package/templates/ko/common/features/feature-base/issue.md +3 -7
- package/templates/ko/common/features/feature-base/pr.md +3 -3
package/package.json
CHANGED
|
@@ -2,6 +2,30 @@
|
|
|
2
2
|
|
|
3
3
|
This documentation is organized by feature to help agents quickly understand the project.
|
|
4
4
|
|
|
5
|
+
## Agent Session Start Checklist
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
# (recommended once at start) run onboarding checks
|
|
9
|
+
npx lee-spec-kit onboard --strict
|
|
10
|
+
|
|
11
|
+
# 1) Detect project
|
|
12
|
+
npx lee-spec-kit detect --json
|
|
13
|
+
|
|
14
|
+
# 2) If detected, read context first
|
|
15
|
+
npx lee-spec-kit context --json-compact
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
- Apply lee-spec-kit workflow only when `isLeeSpecKitProject: true`.
|
|
19
|
+
- When `actionOptions` exist, show `approvalPrompt`/`finalPrompt` exactly as provided and wait for user approval (`<LABEL>` or `<LABEL> OK`) before execution.
|
|
20
|
+
- If `isLeeSpecKitProject: false`, skip lee-spec-kit-specific flow and continue with normal workflow.
|
|
21
|
+
|
|
22
|
+
## New Project Start Order
|
|
23
|
+
|
|
24
|
+
- Scaffold the code project first (for example Next.js/NestJS), then run `lee-spec-kit init`.
|
|
25
|
+
- After that, verify detection with `detect --json`, then continue with `feature` and `context`.
|
|
26
|
+
- In most cases (default: embedded), the steps above are all you need.
|
|
27
|
+
- Choose standalone only when docs are managed separately from the code repo. In that case, prefer running init from a parent workspace folder (for example `workspace/docs`, `workspace/project`) and set both docs/project paths together. (e.g. `npx lee-spec-kit init --docs-repo standalone --dir ./docs --project-root ./project`)
|
|
28
|
+
|
|
5
29
|
## Directory Structure
|
|
6
30
|
|
|
7
31
|
| Path | Purpose | Key Documents |
|
|
@@ -33,7 +33,7 @@ Prohibited:
|
|
|
33
33
|
## ๐งพ Label Response Contract (SSOT)
|
|
34
34
|
|
|
35
35
|
- End **every user-facing reply** with current status + available labels.
|
|
36
|
-
- Use the latest `npx lee-spec-kit context --json` (or `flow --json`
|
|
36
|
+
- Use the latest `npx lee-spec-kit context --json-compact` as the default source (fallback: `context --json` or `flow --json` when full detail is required).
|
|
37
37
|
- Use `actionOptions[].detail` or command `cmd` **verbatim**. Do not paraphrase.
|
|
38
38
|
- Even when the user asks something else, append the same label block at the end if executable labels exist.
|
|
39
39
|
- If no executable labels exist, print `Available labels: none` and guide re-check with `npx lee-spec-kit context`.
|
|
@@ -74,8 +74,9 @@ Include the artifacts in the PR body.
|
|
|
74
74
|
|
|
75
75
|
> - If this includes UI changes, include **screenshots**.
|
|
76
76
|
> - If this includes logic/structure changes, include a **diagram**.
|
|
77
|
+
> - `--mermaid auto` includes a diagram by default; use `--mermaid off` only when no logic/structure change exists.
|
|
77
78
|
|
|
78
|
-
#### UI changes
|
|
79
|
+
#### UI changes
|
|
79
80
|
|
|
80
81
|
- Default is `pr.screenshots.upload: false`. If you need upload/URL inclusion, enable it in `.lee-spec-kit.json`.
|
|
81
82
|
- If `.lee-spec-kit.json` has `pr.screenshots.upload: false`, **do not upload/include URLs**, and **do not include a "Screenshots" section** in the PR body.
|
|
@@ -135,9 +136,10 @@ gh release upload "$TAG" /tmp/lee-spec-kit/pr-assets/* --clobber
|
|
|
135
136
|
echo \"\"
|
|
136
137
|
```
|
|
137
138
|
|
|
138
|
-
#### Logic/structure changes
|
|
139
|
+
#### Logic/structure changes
|
|
139
140
|
|
|
140
141
|
- Write a Mermaid **`sequenceDiagram`** in the PR body and keep it aligned with the generated body template format.
|
|
142
|
+
- Apply this rule based on change type (logic/structure), not by frontend/backend classification.
|
|
141
143
|
|
|
142
144
|
### 4. Request User Approval + Move to `Ready`
|
|
143
145
|
|
|
@@ -22,12 +22,8 @@
|
|
|
22
22
|
- [ ] (verifiable criterion 1)
|
|
23
23
|
- [ ] (verifiable criterion 2)
|
|
24
24
|
|
|
25
|
-
## Out of Scope
|
|
26
|
-
|
|
27
|
-
- (what this issue does not cover)
|
|
28
|
-
|
|
29
25
|
## Related Docs
|
|
30
26
|
|
|
31
|
-
- Spec:
|
|
32
|
-
- Plan:
|
|
33
|
-
- Tasks:
|
|
27
|
+
- Spec: `docs/.../spec.md`
|
|
28
|
+
- Plan: `docs/.../plan.md`
|
|
29
|
+
- Tasks: `docs/.../tasks.md`
|
|
@@ -2,6 +2,30 @@
|
|
|
2
2
|
|
|
3
3
|
์์ด์ ํธ๊ฐ ํ๋ก์ ํธ ์ ๋ฐ์ ๋น ๋ฅด๊ฒ ํ์
ํ ์ ์๋๋ก ๋ฌธ์๋ฅผ ๊ธฐ๋ฅ๋ณ๋ก ๋ถ๋ฆฌํด ๋์์ต๋๋ค.
|
|
4
4
|
|
|
5
|
+
## ์์ด์ ํธ ์ธ์
์์ ์ฒดํฌ๋ฆฌ์คํธ
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
# (์ต์ด 1ํ ๊ถ์ฅ) ์ด๊ธฐ ์จ๋ณด๋ฉ ์ ๊ฒ
|
|
9
|
+
npx lee-spec-kit onboard --strict
|
|
10
|
+
|
|
11
|
+
# 1) ํ๋ก์ ํธ ๊ฐ์ง
|
|
12
|
+
npx lee-spec-kit detect --json
|
|
13
|
+
|
|
14
|
+
# 2) ๊ฐ์ง ์ฑ๊ณต ์ ์ปจํ
์คํธ ์กฐํ
|
|
15
|
+
npx lee-spec-kit context --json-compact
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
- `isLeeSpecKitProject: true`์ผ ๋๋ง lee-spec-kit ์ํฌํ๋ก์ฐ๋ฅผ ์ ์ฉํฉ๋๋ค.
|
|
19
|
+
- `actionOptions`๊ฐ ์์ผ๋ฉด `approvalPrompt`/`finalPrompt`๋ฅผ ๊ทธ๋๋ก ์ฌ์ฉ์์๊ฒ ๋ณด์ฌ์ฃผ๊ณ ์น์ธ(`<LABEL>` ๋๋ `<LABEL> OK`)์ ๋ฐ์ ๋ค ์คํํฉ๋๋ค.
|
|
20
|
+
- `isLeeSpecKitProject: false`๋ฉด lee-spec-kit ์ ์ฉ ์ ์ฐจ๋ฅผ ๊ฑด๋๋ฐ๊ณ ์ผ๋ฐ ์ํฌํ๋ก์ฐ๋ก ์งํํฉ๋๋ค.
|
|
21
|
+
|
|
22
|
+
## ์ ๊ท ํ๋ก์ ํธ ์์ ์์
|
|
23
|
+
|
|
24
|
+
- ์ฝ๋ ํ๋ก์ ํธ ์ค์บํด๋ฉ(์: Next.js/NestJS) ํ `lee-spec-kit init`์ ์คํํ์ธ์.
|
|
25
|
+
- ๊ทธ ๋ค์ `detect --json`์ผ๋ก ๊ฐ์ง ๊ฒฐ๊ณผ๋ฅผ ํ์ธํ๊ณ , `feature`/`context` ์์๋ก ์งํํ์ธ์.
|
|
26
|
+
- ๋๋ถ๋ถ์ ๊ฒฝ์ฐ(๊ธฐ๋ณธ๊ฐ: embedded) ์ ์์๋ง ๋ฐ๋ฅด๋ฉด ๋ฉ๋๋ค.
|
|
27
|
+
- docs๋ฅผ ์ฝ๋ ์ ์ฅ์์ ๋ถ๋ฆฌํด ์ด์ํ ๋๋ง standalone์ ์ ํํ์ธ์. ์ด๋๋ ์์ ์ํฌ์คํ์ด์ค ํด๋(์: `workspace/docs`, `workspace/project`)์์ `init`์ ์คํํด docs/project ๊ฒฝ๋ก๋ฅผ ํจ๊ป ์ง์ ํ๋ ๋ฐฉ์์ ๊ถ์ฅํฉ๋๋ค. (์: `npx lee-spec-kit init --docs-repo standalone --dir ./docs --project-root ./project`)
|
|
28
|
+
|
|
5
29
|
## ์์ ๊ตฌ์กฐ ์์ฝ
|
|
6
30
|
|
|
7
31
|
| ๊ฒฝ๋ก | ๋ชฉ์ | ํต์ฌ ๋ฌธ์/์ญํ |
|
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
## ๐งพ ๋ผ๋ฒจ ์๋ต ๊ณ์ฝ (SSOT)
|
|
34
34
|
|
|
35
35
|
- ์ฌ์ฉ์์๊ฒ ๋ณด๋ด๋ **๋ชจ๋ ์๋ต์ ๋ง์ง๋ง**์ ํ์ฌ ์ํ + ์ ํ ๊ฐ๋ฅํ ๋ผ๋ฒจ์ ํ์ํฉ๋๋ค.
|
|
36
|
-
- ๊ธฐ์ค ๋ฐ์ดํฐ๋ ์ต์ `npx lee-spec-kit context --json`(๋๋ `flow --json`)
|
|
36
|
+
- ๊ธฐ์ค ๋ฐ์ดํฐ๋ ์ต์ `npx lee-spec-kit context --json-compact`๋ฅผ ๊ธฐ๋ณธ์ผ๋ก ์ฌ์ฉํ๊ณ , ์์ธ ํ๋๊ฐ ํ์ํ ๋๋ง `context --json`(๋๋ `flow --json`)์ ์ฌ์ฉํฉ๋๋ค.
|
|
37
37
|
- ๋ผ๋ฒจ ์ค๋ช
์ `actionOptions[].detail` ๋๋ command `cmd`๋ฅผ **์๋ฌธ ๊ทธ๋๋ก** ์ฌ์ฉํฉ๋๋ค. (์์ฝ/์์ญ ๊ธ์ง)
|
|
38
38
|
- ์ฌ์ฉ์๊ฐ ๋ค๋ฅธ ์ง๋ฌธ์ ํ๋๋ผ๋, ์คํ ๊ฐ๋ฅํ ๋ผ๋ฒจ์ด ์์ผ๋ฉด ์๋ต ๋ง์ง๋ง์ ๋์ผ ๋ธ๋ก์ ๋ค์ ํ์ํฉ๋๋ค.
|
|
39
39
|
- ์คํ ๊ฐ๋ฅํ ๋ผ๋ฒจ์ด ์์ผ๋ฉด `์ ํ ๊ฐ๋ฅ: ์์` + `npx lee-spec-kit context` ์ฌํ์ธ์ ์๋ดํฉ๋๋ค.
|
|
@@ -74,8 +74,9 @@ PR ๋ณธ๋ฌธ์ ๊ฒฐ๊ณผ๋ฌผ์ ํฌํจํฉ๋๋ค.
|
|
|
74
74
|
|
|
75
75
|
> - UI ๋ณ๊ฒฝ์ ํด๋น๋๋ค๋ฉด **์คํฌ๋ฆฐ์ท์** ํฌํจํ์ธ์.
|
|
76
76
|
> - ๋ก์ง/๊ตฌ์กฐ ๋ณ๊ฒฝ์ ํด๋น๋๋ค๋ฉด **๋ค์ด์ด๊ทธ๋จ์** ํฌํจํ์ธ์.
|
|
77
|
+
> - `--mermaid auto`๋ ๊ธฐ๋ณธ์ ์ผ๋ก ๋ค์ด์ด๊ทธ๋จ์ ํฌํจํฉ๋๋ค. ๋ก์ง/๊ตฌ์กฐ ๋ณ๊ฒฝ์ด ์ ํ ์๋ ๊ฒฝ์ฐ์๋ง `--mermaid off`๋ฅผ ์ฌ์ฉํ์ธ์.
|
|
77
78
|
|
|
78
|
-
#### UI ๋ณ๊ฒฝ
|
|
79
|
+
#### UI ๋ณ๊ฒฝ
|
|
79
80
|
|
|
80
81
|
- ๊ธฐ๋ณธ๊ฐ์ `pr.screenshots.upload: false`์
๋๋ค. ์
๋ก๋/URL ํฌํจ์ด ํ์ํ๋ค๋ฉด `.lee-spec-kit.json`์์ `true`๋ก ์ผ์ธ์.
|
|
81
82
|
- `.lee-spec-kit.json`์์ `pr.screenshots.upload: false`๋ผ๋ฉด **์
๋ก๋/URL ํฌํจ์ ํ์ง ์์ผ๋ฉฐ**, PR ๋ณธ๋ฌธ์์๋ **"์คํฌ๋ฆฐ์ท" ์น์
์ ๋ง๋ค์ง ์์ต๋๋ค.**
|
|
@@ -135,9 +136,10 @@ gh release upload "$TAG" /tmp/lee-spec-kit/pr-assets/* --clobber
|
|
|
135
136
|
echo \"\"
|
|
136
137
|
```
|
|
137
138
|
|
|
138
|
-
#### ๋ก์ง/๊ตฌ์กฐ ๋ณ๊ฒฝ
|
|
139
|
+
#### ๋ก์ง/๊ตฌ์กฐ ๋ณ๊ฒฝ
|
|
139
140
|
|
|
140
141
|
- PR ๋ณธ๋ฌธ์ Mermaid **`sequenceDiagram`**์ ์์ฑํ๊ณ , ์์ฑ๋ ๋ณธ๋ฌธ ํ
ํ๋ฆฟ ํ์๊ณผ ์ผ์นํ๊ฒ ์ ์งํฉ๋๋ค.
|
|
142
|
+
- ์ด ๊ธฐ์ค์ ํ๋ก ํธ/๋ฐฑ์๋ ๊ตฌ๋ถ์ด ์๋๋ผ ๋ณ๊ฒฝ ์ ํ(๋ก์ง/๊ตฌ์กฐ) ๊ธฐ์ค์ผ๋ก ์ ์ฉํฉ๋๋ค.
|
|
141
143
|
|
|
142
144
|
### 4. ์ฌ์ฉ์ ํ์ธ ์์ฒญ + `Ready` ์ ํ
|
|
143
145
|
|
|
@@ -22,12 +22,8 @@
|
|
|
22
22
|
- [ ] (๊ฒ์ฆ ๊ฐ๋ฅํ ์๋ฃ ๊ธฐ์ค 1)
|
|
23
23
|
- [ ] (๊ฒ์ฆ ๊ฐ๋ฅํ ์๋ฃ ๊ธฐ์ค 2)
|
|
24
24
|
|
|
25
|
-
## ์ ์ธ ๋ฒ์
|
|
26
|
-
|
|
27
|
-
- (์ด๋ฒ ์ด์์์ ๋ค๋ฃจ์ง ์๋ ๋ด์ฉ)
|
|
28
|
-
|
|
29
25
|
## ๊ด๋ จ ๋ฌธ์
|
|
30
26
|
|
|
31
|
-
- Spec:
|
|
32
|
-
- Plan:
|
|
33
|
-
- Tasks:
|
|
27
|
+
- Spec: `docs/.../spec.md`
|
|
28
|
+
- Plan: `docs/.../plan.md`
|
|
29
|
+
- Tasks: `docs/.../tasks.md`
|