lee-spec-kit 0.6.8 β 0.6.10
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 +14 -16
- package/README.md +20 -22
- package/dist/index.js +239 -148
- package/package.json +1 -1
- package/templates/en/common/agents/agents.md +12 -0
- package/templates/en/common/agents/git-workflow.md +1 -1
- package/templates/en/common/agents/issue-template.md +3 -3
- package/templates/en/common/agents/skills/create-issue.md +2 -2
- package/templates/en/common/agents/skills/create-pr.md +2 -2
- package/templates/en/common/features/README.md +1 -1
- package/templates/en/common/features/feature-base/plan.md +1 -1
- package/templates/en/common/features/feature-base/spec.md +1 -1
- package/templates/en/common/features/feature-base/tasks.md +1 -1
- package/templates/en/common/ideas/README.md +1 -1
- package/templates/ko/common/agents/agents.md +12 -0
- package/templates/ko/common/agents/git-workflow.md +1 -1
- package/templates/ko/common/agents/issue-template.md +3 -3
- package/templates/ko/common/agents/skills/create-issue.md +2 -2
- package/templates/ko/common/agents/skills/create-pr.md +2 -2
- package/templates/ko/common/features/README.md +1 -1
- package/templates/ko/common/features/feature-base/plan.md +1 -1
- package/templates/ko/common/features/feature-base/spec.md +1 -1
- package/templates/ko/common/features/feature-base/tasks.md +1 -1
- package/templates/ko/common/ideas/README.md +1 -1
package/package.json
CHANGED
|
@@ -51,6 +51,18 @@ Reply format: "<LABEL>" or "<LABEL> OK"
|
|
|
51
51
|
|
|
52
52
|
---
|
|
53
53
|
|
|
54
|
+
## π Built-in Docs Read Policy (MUST)
|
|
55
|
+
|
|
56
|
+
- Use `docs get` once per session start (or right after context compression/reset).
|
|
57
|
+
- Do not re-read the same doc again in the same session.
|
|
58
|
+
- From `requiredDocs[*].command`, fetch only docs not yet read in this session.
|
|
59
|
+
- You may re-read only when:
|
|
60
|
+
- user explicitly asks for policy refresh
|
|
61
|
+
- policy/config changed (for example after `update`)
|
|
62
|
+
- session restarted or context was compressed/reset
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
54
66
|
## Required References
|
|
55
67
|
|
|
56
68
|
- Highest-priority custom rules: `/docs/agents/custom.md`
|
|
@@ -70,7 +70,7 @@ main
|
|
|
70
70
|
|
|
71
71
|
## Automation Workflow
|
|
72
72
|
|
|
73
|
-
> π Read
|
|
73
|
+
> π Read step guides via `docs get`, but do not re-read the same doc in the same session. (Re-read only after session/compression reset, policy/config changes, or explicit user refresh request.)
|
|
74
74
|
|
|
75
75
|
| Workflow | Guide |
|
|
76
76
|
| -------------- | -------------------------------------------------- |
|
|
@@ -58,8 +58,8 @@ In GitHub Issues, use different link formats **based on file location**:
|
|
|
58
58
|
> Format: `- **{Label}**: \`{path}\``
|
|
59
59
|
|
|
60
60
|
```markdown
|
|
61
|
-
- **Spec**: `docs/features/{
|
|
62
|
-
- **Tasks**: `docs/features/{
|
|
61
|
+
- **Spec**: `docs/features/{component}/F001-feature-name/spec.md`
|
|
62
|
+
- **Tasks**: `docs/features/{component}/F001-feature-name/tasks.md`
|
|
63
63
|
```
|
|
64
64
|
|
|
65
65
|
> β οΈ Local documents are not clickable on GitHub, so use **bold label + code block path** format instead of markdown links.
|
|
@@ -85,7 +85,7 @@ In GitHub Issues, use different link formats **based on file location**:
|
|
|
85
85
|
|
|
86
86
|
## Related Documents
|
|
87
87
|
|
|
88
|
-
- **Spec**: `docs/features/{
|
|
88
|
+
- **Spec**: `docs/features/{component}/F{number}-{feature-name}/spec.md`
|
|
89
89
|
|
|
90
90
|
## Labels
|
|
91
91
|
|
|
@@ -15,10 +15,10 @@ Guide for creating GitHub Issues.
|
|
|
15
15
|
|
|
16
16
|
### 1. Prepare Issue Draft
|
|
17
17
|
|
|
18
|
-
> π **
|
|
18
|
+
> π **If not read in this session, read procedure/template via `docs get`; do not re-read the same doc in the same session, then generate a draft and treat it as the source of truth.**
|
|
19
19
|
|
|
20
20
|
```bash
|
|
21
|
-
# 1) Read procedure + template policy
|
|
21
|
+
# 1) Read procedure + template policy (only docs not read in this session)
|
|
22
22
|
npx lee-spec-kit docs get create-issue --json
|
|
23
23
|
npx lee-spec-kit docs get issue-template --json
|
|
24
24
|
|
|
@@ -17,10 +17,10 @@ Guide for creating Pull Requests.
|
|
|
17
17
|
|
|
18
18
|
### 1. Prepare PR Body Template
|
|
19
19
|
|
|
20
|
-
> π **
|
|
20
|
+
> π **If not read in this session, read procedure/template via `docs get`; do not re-read the same doc in the same session, then generate a body template and treat it as the source of truth.**
|
|
21
21
|
|
|
22
22
|
```bash
|
|
23
|
-
# 1) Read procedure + template policy
|
|
23
|
+
# 1) Read procedure + template policy (only docs not read in this session)
|
|
24
24
|
npx lee-spec-kit docs get create-pr --json
|
|
25
25
|
npx lee-spec-kit docs get pr-template --json
|
|
26
26
|
|
|
@@ -27,7 +27,7 @@ features/
|
|
|
27
27
|
npx lee-spec-kit feature user-auth
|
|
28
28
|
|
|
29
29
|
# Multi project
|
|
30
|
-
npx lee-spec-kit feature --component
|
|
30
|
+
npx lee-spec-kit feature --component app user-profile
|
|
31
31
|
```
|
|
32
32
|
|
|
33
33
|
> π‘ CLI copies templates from `feature-base/` and auto-assigns IDs.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
- **Feature ID**: F{number}
|
|
10
10
|
- **Feature Name**: {feature-name}
|
|
11
|
-
- **Target Repo**: {{projectName}}-{
|
|
11
|
+
- **Target Repo**: {{projectName}}-{component}
|
|
12
12
|
- **Issue Number**: #{issue-number}
|
|
13
13
|
- **Created**: {YYYY-MM-DD}
|
|
14
14
|
- **Status**: Review | Approved
|
|
@@ -14,7 +14,7 @@ Core rule: once an idea becomes a Feature, the SSOT moves to `docs/features/`.
|
|
|
14
14
|
- Put at least these at the top:
|
|
15
15
|
- Goal / context
|
|
16
16
|
- Rough scope (whatβs in/out)
|
|
17
|
-
- Target
|
|
17
|
+
- Target component (optional): `api` / `app` / `worker` / `all`
|
|
18
18
|
|
|
19
19
|
---
|
|
20
20
|
|
|
@@ -51,6 +51,18 @@ B: <detail>
|
|
|
51
51
|
|
|
52
52
|
---
|
|
53
53
|
|
|
54
|
+
## π λ΄μ₯ λ¬Έμ μ‘°ν κ·μΉ (MUST)
|
|
55
|
+
|
|
56
|
+
- `docs get`μ μΈμ
μμ(λλ context μμΆ/리μ
μ§ν) κΈ°μ€μΌλ‘ 1ν νμΈν©λλ€.
|
|
57
|
+
- κ°μ μΈμ
μμ μ΄λ―Έ μ½μ λμΌ λ¬Έμλ λ€μ μ½μ§ μμ΅λλ€.
|
|
58
|
+
- νμ¬ μ‘μ
μ `requiredDocs[*].command` μ€ μ΄λ² μΈμ
μ μμ§ μ½μ§ μμ λ¬Έμλ§ μΆκ° μ‘°νν©λλ€.
|
|
59
|
+
- μλ κ²½μ°μλ μμΈμ μΌλ‘ μ¬μ‘°νν μ μμ΅λλ€:
|
|
60
|
+
- μ¬μ©μκ° μ μ±
μλ‘κ³ μΉ¨μ μμ²ν κ²½μ°
|
|
61
|
+
- `update` μ€ν λ±μΌλ‘ μ μ±
/μ€μ μ΄ λ³κ²½λ κ²½μ°
|
|
62
|
+
- μΈμ
μ΄ μλ‘ μμλμκ±°λ context μμΆ/리μ
μ΄ λ°μν κ²½μ°
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
54
66
|
## νμ μ°Έμ‘°
|
|
55
67
|
|
|
56
68
|
- μ΅μ°μ κ·μΉ: `/docs/agents/custom.md`
|
|
@@ -70,7 +70,7 @@ main
|
|
|
70
70
|
|
|
71
71
|
## μλν μν¬νλ‘μ°
|
|
72
72
|
|
|
73
|
-
> π λ¨κ³λ³ μμΈ κ°μ΄λλ `docs get
|
|
73
|
+
> π λ¨κ³λ³ μμΈ κ°μ΄λλ `docs get`μΌλ‘ νμΈνλ, κ°μ μΈμ
μμ μ΄λ―Έ μ½μ λμΌ λ¬Έμλ λ€μ νΈμΆνμ§ λ§μΈμ. (μΈμ
μμ/μμΆ ν, μ μ±
Β·μ€μ λ³κ²½, μ¬μ©μ μλ‘κ³ μΉ¨ μμ² μμλ§ μ¬μ‘°ν)
|
|
74
74
|
|
|
75
75
|
| μν¬νλ‘μ° | κ°μ΄λ |
|
|
76
76
|
| ------------ | -------------------------------------------------- |
|
|
@@ -42,8 +42,8 @@ GitHub Issueμμ λ§ν¬λ **νμΌ μμΉμ λ°λΌ** λ€λ₯΄κ² μμ±:
|
|
|
42
42
|
> νμ: `- **{λ μ΄λΈ}**: \`{κ²½λ‘}\``
|
|
43
43
|
|
|
44
44
|
```markdown
|
|
45
|
-
- **Spec**: `docs/features/{
|
|
46
|
-
- **Tasks**: `docs/features/{
|
|
45
|
+
- **Spec**: `docs/features/{component}/F001-feature-name/spec.md`
|
|
46
|
+
- **Tasks**: `docs/features/{component}/F001-feature-name/tasks.md`
|
|
47
47
|
```
|
|
48
48
|
|
|
49
49
|
> β οΈ λ‘컬 λ¬Έμλ GitHubμμ ν΄λ¦λμ§ μμΌλ―λ‘, λ§ν¬λ€μ΄ λ§ν¬ λμ **λ³Όλ λ μ΄λΈ + μ½λλΈλ‘ κ²½λ‘** νμμ μ¬μ©ν©λλ€.
|
|
@@ -69,7 +69,7 @@ GitHub Issueμμ λ§ν¬λ **νμΌ μμΉμ λ°λΌ** λ€λ₯΄κ² μμ±:
|
|
|
69
69
|
|
|
70
70
|
## κ΄λ ¨ λ¬Έμ
|
|
71
71
|
|
|
72
|
-
- **Spec**: `docs/features/{
|
|
72
|
+
- **Spec**: `docs/features/{component}/F{λ²νΈ}-{κΈ°λ₯λͺ
}/spec.md`
|
|
73
73
|
|
|
74
74
|
## λΌλ²¨
|
|
75
75
|
|
|
@@ -15,10 +15,10 @@ GitHub Issueλ₯Ό μμ±ν λ λ°λ₯΄λ κ°μ΄λμ
λλ€.
|
|
|
15
15
|
|
|
16
16
|
### 1. μ΄μ μ΄μ μμ±
|
|
17
17
|
|
|
18
|
-
> π
|
|
18
|
+
> π **μ΄λ² μΈμ
μ μμ§ μ½μ§ μμλ€λ©΄ `docs get`μΌλ‘ μ μ°¨/ν
νλ¦Ώμ μ½κ³ , μ΄λ―Έ μ½μ λμΌ λ¬Έμλ μ¬νΈμΆνμ§ μμ μ± μ΄μμ μμ±ν΄ κΈ°μ€μΌλ‘ μ¬μ©νμΈμ.**
|
|
19
19
|
|
|
20
20
|
```bash
|
|
21
|
-
# 1) μ μ°¨/ν
νλ¦Ώ μ μ±
νμΈ
|
|
21
|
+
# 1) μ μ°¨/ν
νλ¦Ώ μ μ±
νμΈ (μ΄λ² μΈμ
λ―ΈνμΈ λ¬Έμλ§)
|
|
22
22
|
npx lee-spec-kit docs get create-issue --json
|
|
23
23
|
npx lee-spec-kit docs get issue-template --json
|
|
24
24
|
|
|
@@ -17,10 +17,10 @@ Pull Requestλ₯Ό μμ±ν λ λ°λ₯΄λ κ°μ΄λμ
λλ€.
|
|
|
17
17
|
|
|
18
18
|
### 1. PR λ³Έλ¬Έ ν
νλ¦Ώ μ€λΉ
|
|
19
19
|
|
|
20
|
-
> π
|
|
20
|
+
> π **μ΄λ² μΈμ
μ μμ§ μ½μ§ μμλ€λ©΄ `docs get`μΌλ‘ μ μ°¨/ν
νλ¦Ώμ μ½κ³ , μ΄λ―Έ μ½μ λμΌ λ¬Έμλ μ¬νΈμΆνμ§ μμ μ± λ³Έλ¬Έ ν
νλ¦Ώμ μμ±ν΄ κΈ°μ€μΌλ‘ μ¬μ©νμΈμ.**
|
|
21
21
|
|
|
22
22
|
```bash
|
|
23
|
-
# 1) μ μ°¨/ν
νλ¦Ώ μ μ±
νμΈ
|
|
23
|
+
# 1) μ μ°¨/ν
νλ¦Ώ μ μ±
νμΈ (μ΄λ² μΈμ
λ―ΈνμΈ λ¬Έμλ§)
|
|
24
24
|
npx lee-spec-kit docs get create-pr --json
|
|
25
25
|
npx lee-spec-kit docs get pr-template --json
|
|
26
26
|
|
|
@@ -27,7 +27,7 @@ features/
|
|
|
27
27
|
npx lee-spec-kit feature user-auth
|
|
28
28
|
|
|
29
29
|
# Multi νλ‘μ νΈ
|
|
30
|
-
npx lee-spec-kit feature --component
|
|
30
|
+
npx lee-spec-kit feature --component app user-profile
|
|
31
31
|
```
|
|
32
32
|
|
|
33
33
|
> π‘ CLIλ `feature-base/`μμ ν
νλ¦Ώμ 볡μ¬νκ³ IDλ₯Ό μλ μ±λ²ν©λλ€.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
- **κΈ°λ₯ ID**: F{λ²νΈ}
|
|
10
10
|
- **κΈ°λ₯λͺ
**: {κΈ°λ₯λͺ
}
|
|
11
|
-
- **λμ λ ν¬**: {{projectName}}-{
|
|
11
|
+
- **λμ λ ν¬**: {{projectName}}-{component}
|
|
12
12
|
- **μ΄μ λ²νΈ**: #{μ΄μλ²νΈ}
|
|
13
13
|
- **μμ±μΌ**: {YYYY-MM-DD}
|
|
14
14
|
- **μν**: Review | Approved
|
|
@@ -14,7 +14,7 @@ Featureλ‘ λ°μ νκΈ° μ μ μμ΄λμ΄ / To-do / μ€ν κΈ°λ‘μ λͺ¨μλ
|
|
|
14
14
|
- μλ¨μ μ΅μν μλ λ©ν μ 보λ₯Ό λ‘λλ€:
|
|
15
15
|
- λͺ©μ /λ°°κ²½
|
|
16
16
|
- λλ΅ λ²μ(λ ν μ§/μ ν μ§)
|
|
17
|
-
- λμ
|
|
17
|
+
- λμ μ»΄ν¬λνΈ(νμ μ): `api` / `app` / `worker` / `all`
|
|
18
18
|
|
|
19
19
|
---
|
|
20
20
|
|