lee-spec-kit 0.6.1 β 0.6.3
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 +23 -2
- package/README.md +23 -2
- package/dist/index.js +1450 -737
- package/package.json +1 -1
- package/templates/en/common/agents/git-workflow.md +8 -8
- package/templates/en/common/agents/pr-template.md +1 -1
- package/templates/en/common/agents/skills/create-issue.md +24 -6
- package/templates/en/common/agents/skills/create-pr.md +25 -7
- package/templates/en/fullstack/README.md +2 -2
- package/templates/en/fullstack/agents/agents.md +18 -21
- package/templates/en/fullstack/features/feature-base/plan.md +1 -1
- package/templates/en/fullstack/features/feature-base/spec.md +1 -1
- package/templates/en/single/README.md +2 -2
- package/templates/en/single/agents/agents.md +18 -22
- package/templates/en/single/features/feature-base/plan.md +1 -1
- package/templates/en/single/features/feature-base/spec.md +1 -1
- package/templates/ko/common/agents/git-workflow.md +8 -8
- package/templates/ko/common/agents/pr-template.md +1 -1
- package/templates/ko/common/agents/skills/create-issue.md +24 -6
- package/templates/ko/common/agents/skills/create-pr.md +25 -7
- package/templates/ko/fullstack/README.md +2 -2
- package/templates/ko/fullstack/agents/agents.md +18 -21
- package/templates/ko/fullstack/features/feature-base/plan.md +1 -1
- package/templates/ko/fullstack/features/feature-base/spec.md +1 -1
- package/templates/ko/single/README.md +2 -2
- package/templates/ko/single/agents/agents.md +18 -21
- package/templates/ko/single/features/feature-base/plan.md +1 -1
- package/templates/ko/single/features/feature-base/spec.md +1 -1
package/package.json
CHANGED
|
@@ -70,14 +70,14 @@ main
|
|
|
70
70
|
|
|
71
71
|
## Automation Workflow
|
|
72
72
|
|
|
73
|
-
> π
|
|
74
|
-
|
|
75
|
-
| Workflow | Guide
|
|
76
|
-
| -------------- |
|
|
77
|
-
| Feature Start | `
|
|
78
|
-
| Issue Creation | `
|
|
79
|
-
| Task Execution | `
|
|
80
|
-
| PR Creation | `
|
|
73
|
+
> π Read each step guide first with `docs get`.
|
|
74
|
+
|
|
75
|
+
| Workflow | Guide |
|
|
76
|
+
| -------------- | -------------------------------------------------- |
|
|
77
|
+
| Feature Start | `npx lee-spec-kit docs get create-feature --json` |
|
|
78
|
+
| Issue Creation | `npx lee-spec-kit docs get create-issue --json` |
|
|
79
|
+
| Task Execution | `npx lee-spec-kit docs get execute-task --json` |
|
|
80
|
+
| PR Creation | `npx lee-spec-kit docs get create-pr --json` |
|
|
81
81
|
|
|
82
82
|
### Branch Creation
|
|
83
83
|
|
|
@@ -65,7 +65,7 @@ For file links within the repo in PR body, **always use current branch name**:
|
|
|
65
65
|
## Screenshots (Frontend / UI changes)
|
|
66
66
|
|
|
67
67
|
<!-- If there are no UI changes, or if screenshot upload is disabled (e.g. `.lee-spec-kit.json` has `pr.screenshots.upload: false`), remove this section. -->
|
|
68
|
-
> If you follow the Release assets upload flow in `
|
|
68
|
+
> If you follow the Release assets upload flow in `npx lee-spec-kit docs get create-pr --json`, you can include images in the PR body without committing files to your branch.
|
|
69
69
|
|
|
70
70
|
{Screenshot markdown (e.g. )}
|
|
71
71
|
|
|
@@ -13,9 +13,22 @@ Guide for creating GitHub Issues.
|
|
|
13
13
|
|
|
14
14
|
## Steps
|
|
15
15
|
|
|
16
|
-
### 1. Prepare Issue
|
|
16
|
+
### 1. Prepare Issue Draft
|
|
17
17
|
|
|
18
|
-
> π **
|
|
18
|
+
> π **Read procedure/template via `docs get` first, then generate a draft and treat it as the source of truth.**
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
# 1) Read procedure + template policy
|
|
22
|
+
npx lee-spec-kit docs get create-issue --json
|
|
23
|
+
npx lee-spec-kit docs get issue-template --json
|
|
24
|
+
|
|
25
|
+
# 2) Generate draft body (no remote action)
|
|
26
|
+
npx lee-spec-kit github issue F001 --json
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Use `docs get issue-template --json` output as the section policy,
|
|
30
|
+
and `github issue --json` output `body` as the first draft to review/share.
|
|
31
|
+
If needed, use `bodyFile` as the filesystem source.
|
|
19
32
|
|
|
20
33
|
| Item | Format |
|
|
21
34
|
| -------- | ------------------------------------------- |
|
|
@@ -28,12 +41,14 @@ Guide for creating GitHub Issues.
|
|
|
28
41
|
|
|
29
42
|
> π¨ **User Approval Required**
|
|
30
43
|
|
|
31
|
-
Before creating issue, share and wait for approval:
|
|
44
|
+
Before creating issue, share and wait for explicit approval (OK):
|
|
32
45
|
|
|
33
46
|
- Title
|
|
34
|
-
-
|
|
47
|
+
- Full body draft (from `body`)
|
|
35
48
|
- Labels
|
|
36
49
|
|
|
50
|
+
Also fill all `TODO` items in Goals/Completion Criteria before creating.
|
|
51
|
+
|
|
37
52
|
### 3. Create Issue
|
|
38
53
|
|
|
39
54
|
```bash
|
|
@@ -42,11 +57,14 @@ gh issue create \
|
|
|
42
57
|
--body-file /tmp/issue-body.md \
|
|
43
58
|
--assignee @me \
|
|
44
59
|
--label enhancement
|
|
60
|
+
|
|
61
|
+
# Or via lee-spec-kit helper (requires explicit confirmation)
|
|
62
|
+
npx lee-spec-kit github issue F001 --create --confirm OK --labels enhancement
|
|
45
63
|
```
|
|
46
64
|
|
|
47
65
|
---
|
|
48
66
|
|
|
49
67
|
## Reference Documents
|
|
50
68
|
|
|
51
|
-
- **
|
|
52
|
-
- **
|
|
69
|
+
- **Draft generator**: `npx lee-spec-kit github issue <feature-name>`
|
|
70
|
+
- **Approval rule**: share title/body/labels first, then run `--create --confirm OK`
|
|
@@ -15,9 +15,22 @@ Guide for creating Pull Requests.
|
|
|
15
15
|
|
|
16
16
|
## Steps
|
|
17
17
|
|
|
18
|
-
### 1. Prepare PR
|
|
18
|
+
### 1. Prepare PR Draft
|
|
19
19
|
|
|
20
|
-
> π **
|
|
20
|
+
> π **Read procedure/template via `docs get` first, then generate a draft and treat it as the source of truth.**
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
# 1) Read procedure + template policy
|
|
24
|
+
npx lee-spec-kit docs get create-pr --json
|
|
25
|
+
npx lee-spec-kit docs get pr-template --json
|
|
26
|
+
|
|
27
|
+
# 2) Generate draft body (no remote action)
|
|
28
|
+
npx lee-spec-kit github pr F001 --json
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Use `docs get pr-template --json` output as the section policy,
|
|
32
|
+
and `github pr --json` output `body` as the first PR draft body.
|
|
33
|
+
If needed, use `bodyFile` as the filesystem source.
|
|
21
34
|
|
|
22
35
|
| Item | Format |
|
|
23
36
|
| -------- | ---------------------------------- |
|
|
@@ -34,7 +47,7 @@ Guide for creating Pull Requests.
|
|
|
34
47
|
|
|
35
48
|
1. Run relevant test commands (e.g., `npm test`, `pnpm test`); if no tests exist, request them from the user
|
|
36
49
|
2. Check results (PASS/FAIL)
|
|
37
|
-
3. In the PR body "Tests" section,
|
|
50
|
+
3. In the PR body "Tests" section, keep only what you actually ran in the generated draft body
|
|
38
51
|
4. If you didnβt run any tests, request/confirm with the user before creating the PR
|
|
39
52
|
|
|
40
53
|
### 3. Prepare Screenshots / Diagrams (Include in PR Body)
|
|
@@ -106,7 +119,7 @@ echo \"\"
|
|
|
106
119
|
|
|
107
120
|
#### Logic/structure changes (Backend PR)
|
|
108
121
|
|
|
109
|
-
- Write a Mermaid **`sequenceDiagram`** in the PR body
|
|
122
|
+
- Write a Mermaid **`sequenceDiagram`** in the PR body and keep it aligned with the generated draft format.
|
|
110
123
|
|
|
111
124
|
### 4. Request User Approval
|
|
112
125
|
|
|
@@ -115,9 +128,11 @@ echo \"\"
|
|
|
115
128
|
Before creating PR, share the following **in a code block** and wait for **explicit approval (OK)**:
|
|
116
129
|
|
|
117
130
|
- Title
|
|
118
|
-
- Full body (`
|
|
131
|
+
- Full body draft (from `body`)
|
|
119
132
|
- Labels (at least 1; cannot be empty)
|
|
120
133
|
|
|
134
|
+
Before approval/create, fill all `TODO` items in the generated draft.
|
|
135
|
+
|
|
121
136
|
### 5. Create PR
|
|
122
137
|
|
|
123
138
|
```bash
|
|
@@ -127,6 +142,9 @@ gh pr create \
|
|
|
127
142
|
--label "{label1,label2}" \
|
|
128
143
|
--assignee @me \
|
|
129
144
|
--base main
|
|
145
|
+
|
|
146
|
+
# Or via lee-spec-kit helper (requires explicit confirmation)
|
|
147
|
+
npx lee-spec-kit github pr F001 --create --confirm OK --labels enhancement
|
|
130
148
|
```
|
|
131
149
|
|
|
132
150
|
---
|
|
@@ -168,5 +186,5 @@ Use **current branch name** for file links in PR body:
|
|
|
168
186
|
|
|
169
187
|
## Reference Documents
|
|
170
188
|
|
|
171
|
-
- **
|
|
172
|
-
- **
|
|
189
|
+
- **Draft generator**: `npx lee-spec-kit github pr <feature-name>`
|
|
190
|
+
- **Approval rule**: share title/body/labels first, then run `--create --confirm OK`
|
|
@@ -6,7 +6,7 @@ This documentation is organized by feature to help agents quickly understand the
|
|
|
6
6
|
|
|
7
7
|
| Path | Purpose | Key Documents |
|
|
8
8
|
| ------------------- | --------------------- | ------------------------------------------------------------- |
|
|
9
|
-
| `docs/agents/` | Agent operating rules | `
|
|
9
|
+
| `docs/agents/` | Agent operating rules | `custom.md`, `constitution.md` (engine-managed guides are fetched via `npx lee-spec-kit docs get <doc-id> --json`) |
|
|
10
10
|
| `docs/prd/` | Product requirements | Project-specific |
|
|
11
11
|
| `docs/designs/` | Design references | `README.md` (links/guidelines/references) |
|
|
12
12
|
| `docs/ideas/` | Ideas / to-dos | `README.md` (Idea β Feature promotion rules) |
|
|
@@ -20,7 +20,7 @@ This documentation is organized by feature to help agents quickly understand the
|
|
|
20
20
|
When you run `lee-spec-kit init`, it creates `.lee-spec-kit.json` in the docs root (default: `docs/`).
|
|
21
21
|
|
|
22
22
|
- Used by `lee-spec-kit feature`, `status`, and `update` to detect docs location / project type / language.
|
|
23
|
-
- `docsRepo`, `pushDocs`, `docsRemote` are metadata for the **Docs Push
|
|
23
|
+
- `docsRepo`, `pushDocs`, `docsRemote` are metadata for the CLI-managed **Docs Push policy** (the CLI does not auto-push).
|
|
24
24
|
|
|
25
25
|
### Fields
|
|
26
26
|
|
|
@@ -40,9 +40,10 @@ Operating rules for AI code assistants to perform consistent code generation and
|
|
|
40
40
|
|
|
41
41
|
- **π΄ Custom Rules (Highest Priority)**: `/docs/agents/custom.md`
|
|
42
42
|
- **Project Principles**: `/docs/agents/constitution.md`
|
|
43
|
-
- **
|
|
44
|
-
- **
|
|
45
|
-
- **
|
|
43
|
+
- **Agent Root Guide**: `npx lee-spec-kit docs get agents --json`
|
|
44
|
+
- **Git Workflow**: `npx lee-spec-kit docs get git-workflow --json`
|
|
45
|
+
- **Issue Procedure/Template**: `npx lee-spec-kit docs get create-issue --json` β `npx lee-spec-kit docs get issue-template --json`
|
|
46
|
+
- **PR Procedure/Template**: `npx lee-spec-kit docs get create-pr --json` β `npx lee-spec-kit docs get pr-template --json`
|
|
46
47
|
|
|
47
48
|
### PRD
|
|
48
49
|
|
|
@@ -52,7 +53,7 @@ Operating rules for AI code assistants to perform consistent code generation and
|
|
|
52
53
|
|
|
53
54
|
- **BE Features**: `/docs/features/be/{feature-id}/`
|
|
54
55
|
- **FE Features**: `/docs/features/fe/{feature-id}/`
|
|
55
|
-
- **Template (SSOT)**:
|
|
56
|
+
- **Template (SSOT)**: docs generated via `npx lee-spec-kit feature <name>`
|
|
56
57
|
|
|
57
58
|
---
|
|
58
59
|
|
|
@@ -62,16 +63,12 @@ Operating rules for AI code assistants to perform consistent code generation and
|
|
|
62
63
|
docs/
|
|
63
64
|
βββ README.md # Documentation guide
|
|
64
65
|
βββ agents/ # Agent operating rules
|
|
65
|
-
β βββ
|
|
66
|
-
β
|
|
67
|
-
β
|
|
68
|
-
β
|
|
69
|
-
β
|
|
70
|
-
β
|
|
71
|
-
β βββ create-feature.md
|
|
72
|
-
β βββ create-issue.md
|
|
73
|
-
β βββ create-pr.md
|
|
74
|
-
β βββ execute-task.md
|
|
66
|
+
β βββ custom.md # Project-specific custom rules
|
|
67
|
+
β βββ constitution.md # Project principles
|
|
68
|
+
β
|
|
69
|
+
β # Engine-managed policy guides are not synced into project docs.
|
|
70
|
+
β # - list: npx lee-spec-kit docs list --json
|
|
71
|
+
β # - example: npx lee-spec-kit docs get git-workflow --json
|
|
75
72
|
βββ prd/ # Product requirements
|
|
76
73
|
βββ designs/ # Design references
|
|
77
74
|
βββ ideas/ # Pre-feature ideas / to-dos
|
|
@@ -85,14 +82,14 @@ docs/
|
|
|
85
82
|
|
|
86
83
|
## Request Type Processes
|
|
87
84
|
|
|
88
|
-
> π
|
|
85
|
+
> π Read each process guide first with `docs get`.
|
|
89
86
|
|
|
90
|
-
| Process | Guide
|
|
91
|
-
| -------------- |
|
|
92
|
-
| New Feature | `
|
|
93
|
-
| GitHub Issue | `
|
|
94
|
-
| Pull Request | `
|
|
95
|
-
| Task Execution | `
|
|
87
|
+
| Process | Guide |
|
|
88
|
+
| -------------- | ------------------------------------- |
|
|
89
|
+
| New Feature | `npx lee-spec-kit docs get create-feature --json` |
|
|
90
|
+
| GitHub Issue | `npx lee-spec-kit docs get create-issue --json` |
|
|
91
|
+
| Pull Request | `npx lee-spec-kit docs get create-pr --json` |
|
|
92
|
+
| Task Execution | `npx lee-spec-kit docs get execute-task --json` |
|
|
96
93
|
|
|
97
94
|
### Additional Rules (Fullstack)
|
|
98
95
|
|
|
@@ -6,7 +6,7 @@ This documentation is organized by feature to help agents quickly understand the
|
|
|
6
6
|
|
|
7
7
|
| Path | Purpose | Key Documents |
|
|
8
8
|
| ---------------- | --------------------- | ------------------------------------------------------------- |
|
|
9
|
-
| `docs/agents/` | Agent operating rules | `
|
|
9
|
+
| `docs/agents/` | Agent operating rules | `custom.md`, `constitution.md` (engine-managed guides are fetched via `npx lee-spec-kit docs get <doc-id> --json`) |
|
|
10
10
|
| `docs/prd/` | Product requirements | Project-specific |
|
|
11
11
|
| `docs/designs/` | Design references | `README.md` (links/guidelines/references) |
|
|
12
12
|
| `docs/ideas/` | Ideas / to-dos | `README.md` (Idea β Feature promotion rules) |
|
|
@@ -19,7 +19,7 @@ This documentation is organized by feature to help agents quickly understand the
|
|
|
19
19
|
When you run `lee-spec-kit init`, it creates `.lee-spec-kit.json` in the docs root (default: `docs/`).
|
|
20
20
|
|
|
21
21
|
- Used by `lee-spec-kit feature`, `status`, and `update` to detect docs location / project type / language.
|
|
22
|
-
- `docsRepo`, `pushDocs`, `docsRemote` are metadata for the **Docs Push
|
|
22
|
+
- `docsRepo`, `pushDocs`, `docsRemote` are metadata for the CLI-managed **Docs Push policy** (the CLI does not auto-push).
|
|
23
23
|
|
|
24
24
|
### Fields
|
|
25
25
|
|
|
@@ -40,14 +40,15 @@ Operating rules for AI code assistants to perform consistent code generation and
|
|
|
40
40
|
|
|
41
41
|
- **π΄ Custom Rules (Highest Priority)**: `/docs/agents/custom.md`
|
|
42
42
|
- **Project Principles**: `/docs/agents/constitution.md`
|
|
43
|
-
- **
|
|
44
|
-
- **
|
|
45
|
-
- **
|
|
43
|
+
- **Agent Root Guide**: `npx lee-spec-kit docs get agents --json`
|
|
44
|
+
- **Git Workflow**: `npx lee-spec-kit docs get git-workflow --json`
|
|
45
|
+
- **Issue Procedure/Template**: `npx lee-spec-kit docs get create-issue --json` β `npx lee-spec-kit docs get issue-template --json`
|
|
46
|
+
- **PR Procedure/Template**: `npx lee-spec-kit docs get create-pr --json` β `npx lee-spec-kit docs get pr-template --json`
|
|
46
47
|
|
|
47
48
|
### Features
|
|
48
49
|
|
|
49
50
|
- **Feature Docs**: `/docs/features/{feature-id}/`
|
|
50
|
-
- **Template (SSOT)**:
|
|
51
|
+
- **Template (SSOT)**: docs generated via `npx lee-spec-kit feature <name>`
|
|
51
52
|
|
|
52
53
|
---
|
|
53
54
|
|
|
@@ -57,21 +58,16 @@ Operating rules for AI code assistants to perform consistent code generation and
|
|
|
57
58
|
docs/
|
|
58
59
|
βββ README.md # Documentation guide
|
|
59
60
|
βββ agents/ # Agent operating rules
|
|
60
|
-
β βββ
|
|
61
|
-
β
|
|
62
|
-
β
|
|
63
|
-
β
|
|
64
|
-
β
|
|
65
|
-
β
|
|
66
|
-
β βββ create-feature.md
|
|
67
|
-
β βββ create-issue.md
|
|
68
|
-
β βββ create-pr.md
|
|
69
|
-
β βββ execute-task.md
|
|
61
|
+
β βββ custom.md # Project-specific custom rules
|
|
62
|
+
β βββ constitution.md # Project principles
|
|
63
|
+
β
|
|
64
|
+
β # Engine-managed policy guides are not synced into project docs.
|
|
65
|
+
β # - list: npx lee-spec-kit docs list --json
|
|
66
|
+
β # - example: npx lee-spec-kit docs get git-workflow --json
|
|
70
67
|
βββ prd/ # Product requirements
|
|
71
68
|
βββ designs/ # Design references
|
|
72
69
|
βββ ideas/ # Pre-feature ideas / to-dos
|
|
73
70
|
βββ features/ # Feature documentation
|
|
74
|
-
β βββ feature-base/ # Template
|
|
75
71
|
β βββ F00X-{name}/
|
|
76
72
|
βββ scripts/ # Utilities
|
|
77
73
|
```
|
|
@@ -80,14 +76,14 @@ docs/
|
|
|
80
76
|
|
|
81
77
|
## Request Type Processes
|
|
82
78
|
|
|
83
|
-
> π
|
|
79
|
+
> π Read each process guide first with `docs get`.
|
|
84
80
|
|
|
85
|
-
| Process | Guide
|
|
86
|
-
| -------------- |
|
|
87
|
-
| New Feature | `
|
|
88
|
-
| GitHub Issue | `
|
|
89
|
-
| Pull Request | `
|
|
90
|
-
| Task Execution | `
|
|
81
|
+
| Process | Guide |
|
|
82
|
+
| -------------- | ------------------------------------- |
|
|
83
|
+
| New Feature | `npx lee-spec-kit docs get create-feature --json` |
|
|
84
|
+
| GitHub Issue | `npx lee-spec-kit docs get create-issue --json` |
|
|
85
|
+
| Pull Request | `npx lee-spec-kit docs get create-pr --json` |
|
|
86
|
+
| Task Execution | `npx lee-spec-kit docs get execute-task --json` |
|
|
91
87
|
|
|
92
88
|
---
|
|
93
89
|
|
|
@@ -70,14 +70,14 @@ main
|
|
|
70
70
|
|
|
71
71
|
## μλν μν¬νλ‘μ°
|
|
72
72
|
|
|
73
|
-
> π λ¨κ³λ³ μμΈ κ°μ΄λλ `
|
|
74
|
-
|
|
75
|
-
| μν¬νλ‘μ° | κ°μ΄λ
|
|
76
|
-
| ------------ |
|
|
77
|
-
| Feature μμ | `
|
|
78
|
-
| Issue μμ± | `
|
|
79
|
-
| νμ€ν¬ μ€ν | `
|
|
80
|
-
| PR μμ± | `
|
|
73
|
+
> π λ¨κ³λ³ μμΈ κ°μ΄λλ `docs get` λͺ
λ ΉμΌλ‘ λ¨Όμ νμΈνμΈμ.
|
|
74
|
+
|
|
75
|
+
| μν¬νλ‘μ° | κ°μ΄λ |
|
|
76
|
+
| ------------ | -------------------------------------------------- |
|
|
77
|
+
| Feature μμ | `npx lee-spec-kit docs get create-feature --json` |
|
|
78
|
+
| Issue μμ± | `npx lee-spec-kit docs get create-issue --json` |
|
|
79
|
+
| νμ€ν¬ μ€ν | `npx lee-spec-kit docs get execute-task --json` |
|
|
80
|
+
| PR μμ± | `npx lee-spec-kit docs get create-pr --json` |
|
|
81
81
|
|
|
82
82
|
### λΈλμΉ μμ±
|
|
83
83
|
|
|
@@ -63,7 +63,7 @@ PR λ³Έλ¬Έμμ λ ν¬ λ΄ νμΌ λ§ν¬λ **λ°λμ νμ¬ λΈλμΉλͺ
μ
|
|
|
63
63
|
## μ€ν¬λ¦°μ· (νλ‘ νΈμλ / UI λ³κ²½ μ)
|
|
64
64
|
|
|
65
65
|
<!-- UI λ³κ²½μ΄ μλκ±°λ, μ€ν¬λ¦°μ·μ μ
λ‘λνμ§ μμλ€λ©΄(μ: `.lee-spec-kit.json`μ `pr.screenshots.upload: false`) μ΄ μΉμ
μ μ κ±°νμΈμ. -->
|
|
66
|
-
> `
|
|
66
|
+
> `npx lee-spec-kit docs get create-pr --json`μ Release assets μ
λ‘λ μ μ°¨λ₯Ό μ¬μ©νλ©΄ λΈλμΉμ νμΌμ 컀λ°νμ§ μκ³ λ μ΄λ―Έμ§λ₯Ό λ³Έλ¬Έμ ν¬ν¨ν μ μμ΅λλ€.
|
|
67
67
|
|
|
68
68
|
{μ€ν¬λ¦°μ· λ§ν¬λ€μ΄ (μ: )}
|
|
69
69
|
|
|
@@ -13,9 +13,22 @@ GitHub Issueλ₯Ό μμ±ν λ λ°λ₯΄λ κ°μ΄λμ
λλ€.
|
|
|
13
13
|
|
|
14
14
|
## λ¨κ³
|
|
15
15
|
|
|
16
|
-
### 1. μ΄μ
|
|
16
|
+
### 1. μ΄μ μ΄μ μμ±
|
|
17
17
|
|
|
18
|
-
> π
|
|
18
|
+
> π **λ¨Όμ `docs get`μΌλ‘ μ μ°¨/ν
νλ¦Ώμ μ½κ³ , μ΄μμ μμ±ν΄ κΈ°μ€μΌλ‘ μ¬μ©νμΈμ.**
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
# 1) μ μ°¨/ν
νλ¦Ώ μ μ±
νμΈ
|
|
22
|
+
npx lee-spec-kit docs get create-issue --json
|
|
23
|
+
npx lee-spec-kit docs get issue-template --json
|
|
24
|
+
|
|
25
|
+
# 2) μ΄μ λ³Έλ¬Έ μμ± (μ격 μμ
μλ)
|
|
26
|
+
npx lee-spec-kit github issue F001 --json
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
`docs get issue-template --json` μΆλ ₯μ μΉμ
μ μ±
μΌλ‘ λ³΄κ³ ,
|
|
30
|
+
`github issue --json`μ `body`λ₯Ό μ°μ λ³Έλ¬Έ μ΄μμΌλ‘ μ¬μ©νμΈμ.
|
|
31
|
+
νμνλ©΄ `bodyFile` κ²½λ‘ νμΌμ ν¨κ» μ°Έκ³ νμΈμ.
|
|
19
32
|
|
|
20
33
|
| νλͺ© | νμ |
|
|
21
34
|
| ------ | ---------------------------------------- |
|
|
@@ -28,12 +41,14 @@ GitHub Issueλ₯Ό μμ±ν λ λ°λ₯΄λ κ°μ΄λμ
λλ€.
|
|
|
28
41
|
|
|
29
42
|
> π¨ **μ¬μ©μ νμΈ νμ**
|
|
30
43
|
|
|
31
|
-
μ΄μ μμ± μ λ€μ λ΄μ©μ 곡μ νκ³ μΉμΈ λκΈ°:
|
|
44
|
+
μ΄μ μμ± μ λ€μ λ΄μ©μ 곡μ νκ³ λͺ
μμ μΉμΈ(OK) λκΈ°:
|
|
32
45
|
|
|
33
46
|
- μ λͺ©
|
|
34
|
-
- λ³Έλ¬Έ
|
|
47
|
+
- λ³Έλ¬Έ μ 체 μ΄μ (`body` κΈ°μ€)
|
|
35
48
|
- λΌλ²¨
|
|
36
49
|
|
|
50
|
+
μμ± μ λͺ©ν/μλ£ κΈ°μ€ μΉμ
μ `TODO` νλͺ©μ λͺ¨λ μ±μ°μΈμ.
|
|
51
|
+
|
|
37
52
|
### 3. μ΄μ μμ±
|
|
38
53
|
|
|
39
54
|
```bash
|
|
@@ -42,11 +57,14 @@ gh issue create \
|
|
|
42
57
|
--body-file /tmp/issue-body.md \
|
|
43
58
|
--assignee @me \
|
|
44
59
|
--label enhancement
|
|
60
|
+
|
|
61
|
+
# λλ lee-spec-kit helper μ¬μ© (λͺ
μμ μΉμΈ νμ)
|
|
62
|
+
npx lee-spec-kit github issue F001 --create --confirm OK --labels enhancement
|
|
45
63
|
```
|
|
46
64
|
|
|
47
65
|
---
|
|
48
66
|
|
|
49
67
|
## μ°Έμ‘° λ¬Έμ
|
|
50
68
|
|
|
51
|
-
-
|
|
52
|
-
-
|
|
69
|
+
- **μ΄μ μμ±κΈ°**: `npx lee-spec-kit github issue <feature-name>`
|
|
70
|
+
- **μΉμΈ κ·μΉ**: μ λͺ©/λ³Έλ¬Έ/λΌλ²¨ 곡μ ν `--create --confirm OK` μ€ν
|
|
@@ -15,9 +15,22 @@ Pull Requestλ₯Ό μμ±ν λ λ°λ₯΄λ κ°μ΄λμ
λλ€.
|
|
|
15
15
|
|
|
16
16
|
## λ¨κ³
|
|
17
17
|
|
|
18
|
-
### 1. PR
|
|
18
|
+
### 1. PR μ΄μ μμ±
|
|
19
19
|
|
|
20
|
-
> π
|
|
20
|
+
> π **λ¨Όμ `docs get`μΌλ‘ μ μ°¨/ν
νλ¦Ώμ μ½κ³ , μ΄μμ μμ±ν΄ κΈ°μ€μΌλ‘ μ¬μ©νμΈμ.**
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
# 1) μ μ°¨/ν
νλ¦Ώ μ μ±
νμΈ
|
|
24
|
+
npx lee-spec-kit docs get create-pr --json
|
|
25
|
+
npx lee-spec-kit docs get pr-template --json
|
|
26
|
+
|
|
27
|
+
# 2) μ΄μ λ³Έλ¬Έ μμ± (μ격 μμ
μλ)
|
|
28
|
+
npx lee-spec-kit github pr F001 --json
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
`docs get pr-template --json` μΆλ ₯μ μΉμ
μ μ±
μΌλ‘ λ³΄κ³ ,
|
|
32
|
+
`github pr --json`μ `body`λ₯Ό μ°μ PR μ΄μ λ³Έλ¬ΈμΌλ‘ μ¬μ©νμΈμ.
|
|
33
|
+
νμνλ©΄ `bodyFile` κ²½λ‘ νμΌμ ν¨κ» μ°Έκ³ νμΈμ.
|
|
21
34
|
|
|
22
35
|
| νλͺ© | νμ |
|
|
23
36
|
| ------ | ---------------------------------- |
|
|
@@ -34,7 +47,7 @@ Pull Requestλ₯Ό μμ±ν λ λ°λ₯΄λ κ°μ΄λμ
λλ€.
|
|
|
34
47
|
|
|
35
48
|
1. μμ
κ³Ό κ΄λ ¨λ ν
μ€νΈ λͺ
λ Ήμ΄ μ€ν (μ: `npm test`, `pnpm test`), ν
μ€νΈκ° μλ κ²½μ° μ¬μ©μμκ² μμ²
|
|
36
49
|
2. κ²°κ³Ό νμΈ (PASS/FAIL)
|
|
37
|
-
3. PR λ³Έλ¬Έ "ν
μ€νΈ" μΉμ
μ
|
|
50
|
+
3. PR λ³Έλ¬Έ "ν
μ€νΈ" μΉμ
μ μμ±λ μ΄μ κΈ°μ€μΌλ‘, μ€μ μ€νν ν
μ€νΈλ§ λ°μν©λλ€.
|
|
38
51
|
4. ν
μ€νΈλ₯Ό μ€ννμ§ μμλ€λ©΄, PR μμ± μ μ μ¬μ©μμκ² μμ²/νμΈν©λλ€.
|
|
39
52
|
|
|
40
53
|
### 3. μ€ν¬λ¦°μ·/λ€μ΄μ΄κ·Έλ¨ μμ± (PR λ³Έλ¬Έμ ν¬ν¨)
|
|
@@ -106,7 +119,7 @@ echo \"\"
|
|
|
106
119
|
|
|
107
120
|
#### λ‘μ§/ꡬ쑰 λ³κ²½ (λ°±μλ PR)
|
|
108
121
|
|
|
109
|
-
- PR λ³Έλ¬Έμ Mermaid **`sequenceDiagram`**μ
|
|
122
|
+
- PR λ³Έλ¬Έμ Mermaid **`sequenceDiagram`**μ μμ±νκ³ , μμ±λ μ΄μ νμκ³Ό μΌμΉνκ² μ μ§ν©λλ€.
|
|
110
123
|
|
|
111
124
|
### 4. μ¬μ©μ νμΈ μμ²
|
|
112
125
|
|
|
@@ -115,9 +128,11 @@ echo \"\"
|
|
|
115
128
|
PR μμ± μ λ€μ λ΄μ©μ **μ½λλΈλ‘μΌλ‘** μ¬μ©μμκ² κ³΅μ νκ³ **λͺ
μμ μΉμΈ(OK)** λκΈ°:
|
|
116
129
|
|
|
117
130
|
- μ λͺ©
|
|
118
|
-
- λ³Έλ¬Έ μ 체 (`
|
|
131
|
+
- λ³Έλ¬Έ μ 체 μ΄μ (`body` κΈ°μ€)
|
|
119
132
|
- λΌλ²¨(μ΅μ 1κ°, λΉμλ μ μμ)
|
|
120
133
|
|
|
134
|
+
μΉμΈ/μμ± μ μ μμ±λ μ΄μμ `TODO` νλͺ©μ λͺ¨λ μ±μ°μΈμ.
|
|
135
|
+
|
|
121
136
|
### 5. PR μμ±
|
|
122
137
|
|
|
123
138
|
```bash
|
|
@@ -127,6 +142,9 @@ gh pr create \
|
|
|
127
142
|
--label "{λΌλ²¨1,λΌλ²¨2}" \
|
|
128
143
|
--assignee @me \
|
|
129
144
|
--base main
|
|
145
|
+
|
|
146
|
+
# λλ lee-spec-kit helper μ¬μ© (λͺ
μμ μΉμΈ νμ)
|
|
147
|
+
npx lee-spec-kit github pr F001 --create --confirm OK --labels enhancement
|
|
130
148
|
```
|
|
131
149
|
|
|
132
150
|
---
|
|
@@ -168,5 +186,5 @@ PR λ³Έλ¬Έμ νμΌ λ§ν¬λ **νμ¬ λΈλμΉλͺ
**μ μ¬μ©:
|
|
|
168
186
|
|
|
169
187
|
## μ°Έμ‘° λ¬Έμ
|
|
170
188
|
|
|
171
|
-
-
|
|
172
|
-
-
|
|
189
|
+
- **μ΄μ μμ±κΈ°**: `npx lee-spec-kit github pr <feature-name>`
|
|
190
|
+
- **μΉμΈ κ·μΉ**: μ λͺ©/λ³Έλ¬Έ/λΌλ²¨ 곡μ ν `--create --confirm OK` μ€ν
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
| κ²½λ‘ | λͺ©μ | ν΅μ¬ λ¬Έμ/μν |
|
|
8
8
|
| ------------------- | -------------------- | ------------------------------------------------------------- |
|
|
9
|
-
| `docs/agents/` | μμ΄μ νΈ μ΄μ κ·μΉ | `
|
|
9
|
+
| `docs/agents/` | μμ΄μ νΈ μ΄μ κ·μΉ | `custom.md`, `constitution.md` (μμ§ μ’
μ κ°μ΄λλ `npx lee-spec-kit docs get <doc-id> --json`μΌλ‘ μ‘°ν) |
|
|
10
10
|
| `docs/prd/` | μ ν μꡬμ¬ν | νλ‘μ νΈλ³ μμ± |
|
|
11
11
|
| `docs/designs/` | λμμΈ μ°Έκ³ μλ£ | `README.md` (λ§ν¬/κ°μ΄λ/λ νΌλ°μ€) |
|
|
12
12
|
| `docs/ideas/` | μμ΄λμ΄/To-do | `README.md` (Idea β Feature μΉκ²© κ·μΉ) |
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
`lee-spec-kit init`μ μ€ννλ©΄ λ¬Έμ 루νΈ(κΈ°λ³Έ: `docs/`)μ `.lee-spec-kit.json`μ΄ μμ±λ©λλ€.
|
|
21
21
|
|
|
22
22
|
- `lee-spec-kit feature`, `status`, `update`μμ λ¬Έμ μμΉ/νλ‘μ νΈ νμ
/μΈμ΄λ₯Ό κ°μ§νλ μ©λλ‘ μ¬μ©λ©λλ€.
|
|
23
|
-
- `docsRepo`, `pushDocs`, `docsRemote`λ
|
|
23
|
+
- `docsRepo`, `pushDocs`, `docsRemote`λ CLI κ΄λ¦¬ **Docs Push μ μ±
**μ μν λ©νλ°μ΄ν°μ
λλ€. (μλ pushλ νμ§ μμ΅λλ€)
|
|
24
24
|
|
|
25
25
|
### νλ
|
|
26
26
|
|
|
@@ -40,9 +40,10 @@
|
|
|
40
40
|
|
|
41
41
|
- **π΄ 컀μ€ν
κ·μΉ (μ΅μ°μ )**: `/docs/agents/custom.md`
|
|
42
42
|
- **νλ‘μ νΈ μμΉ**: `/docs/agents/constitution.md`
|
|
43
|
-
-
|
|
44
|
-
-
|
|
45
|
-
-
|
|
43
|
+
- **μμ΄μ νΈ λ£¨νΈ κ°μ΄λ**: `npx lee-spec-kit docs get agents --json`
|
|
44
|
+
- **Git μν¬νλ‘μ°**: `npx lee-spec-kit docs get git-workflow --json`
|
|
45
|
+
- **μ΄μ μ μ°¨/ν
νλ¦Ώ**: `npx lee-spec-kit docs get create-issue --json` β `npx lee-spec-kit docs get issue-template --json`
|
|
46
|
+
- **PR μ μ°¨/ν
νλ¦Ώ**: `npx lee-spec-kit docs get create-pr --json` β `npx lee-spec-kit docs get pr-template --json`
|
|
46
47
|
|
|
47
48
|
### PRD
|
|
48
49
|
|
|
@@ -52,7 +53,7 @@
|
|
|
52
53
|
|
|
53
54
|
- **BE κΈ°λ₯**: `/docs/features/be/{feature-id}/`
|
|
54
55
|
- **FE κΈ°λ₯**: `/docs/features/fe/{feature-id}/`
|
|
55
|
-
- **ν
νλ¦Ώ (SSOT)**:
|
|
56
|
+
- **ν
νλ¦Ώ (SSOT)**: `npx lee-spec-kit feature <name>`λ‘ μμ±λ λ¬Έμ ꡬ쑰 (spec, plan, tasks, decisions)
|
|
56
57
|
|
|
57
58
|
---
|
|
58
59
|
|
|
@@ -62,16 +63,12 @@
|
|
|
62
63
|
docs/
|
|
63
64
|
βββ README.md # λ¬Έμ μλ΄
|
|
64
65
|
βββ agents/ # μμ΄μ νΈ μ΄μ κ·μΉ
|
|
65
|
-
β βββ
|
|
66
|
-
β
|
|
67
|
-
β
|
|
68
|
-
β
|
|
69
|
-
β
|
|
70
|
-
β
|
|
71
|
-
β βββ create-feature.md
|
|
72
|
-
β βββ create-issue.md
|
|
73
|
-
β βββ create-pr.md
|
|
74
|
-
β βββ execute-task.md
|
|
66
|
+
β βββ custom.md # νλ‘μ νΈλ³ 컀μ€ν
κ·μΉ
|
|
67
|
+
β βββ constitution.md # νλ‘μ νΈ μμΉ
|
|
68
|
+
β
|
|
69
|
+
β # μμ§ μ’
μ κ°μ΄λλ νλ‘μ νΈ docsμ λκΈ°νλμ§ μμ΅λλ€.
|
|
70
|
+
β # - μ‘°ν: npx lee-spec-kit docs list --json
|
|
71
|
+
β # - μμ: npx lee-spec-kit docs get git-workflow --json
|
|
75
72
|
βββ prd/ # μ ν μꡬμ¬ν
|
|
76
73
|
βββ designs/ # λμμΈ μ°Έκ³ μλ£
|
|
77
74
|
βββ ideas/ # μμ΄λμ΄/To-do (Feature μΉκ²© μ )
|
|
@@ -101,14 +98,14 @@ docs/
|
|
|
101
98
|
|
|
102
99
|
## μμ² μ νλ³ νλ‘μΈμ€
|
|
103
100
|
|
|
104
|
-
> π κ° νλ‘μΈμ€μ μμΈ κ°μ΄λλ `
|
|
101
|
+
> π κ° νλ‘μΈμ€μ μμΈ κ°μ΄λλ `docs get` λͺ
λ ΉμΌλ‘ λ¨Όμ μ‘°ννμΈμ.
|
|
105
102
|
|
|
106
|
-
| νλ‘μΈμ€ | κ°μ΄λ
|
|
107
|
-
| ----------------- |
|
|
108
|
-
| μ κΈ°λ₯ μΆκ° | `
|
|
109
|
-
| GitHub Issue μμ± | `
|
|
110
|
-
| Pull Request μμ± | `
|
|
111
|
-
| νμ€ν¬ μ€ν | `
|
|
103
|
+
| νλ‘μΈμ€ | κ°μ΄λ |
|
|
104
|
+
| ----------------- | --------------------------------- |
|
|
105
|
+
| μ κΈ°λ₯ μΆκ° | `npx lee-spec-kit docs get create-feature --json` |
|
|
106
|
+
| GitHub Issue μμ± | `npx lee-spec-kit docs get create-issue --json` |
|
|
107
|
+
| Pull Request μμ± | `npx lee-spec-kit docs get create-pr --json` |
|
|
108
|
+
| νμ€ν¬ μ€ν | `npx lee-spec-kit docs get execute-task --json` |
|
|
112
109
|
|
|
113
110
|
### μΆκ° κ·μΉ (Fullstack)
|
|
114
111
|
|