lee-spec-kit 0.4.10 → 0.4.12

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "lee-spec-kit",
3
- "version": "0.4.10",
3
+ "version": "0.4.12",
4
4
  "description": "Project documentation structure generator for AI-assisted development",
5
5
  "type": "module",
6
6
  "bin": {
@@ -42,15 +42,20 @@ For file links within the repo in PR body, **always use current branch name**:
42
42
 
43
43
  ## Tests
44
44
 
45
- > ⚠️ **Check only after running tests. Do NOT check items that were not executed.**
45
+ > ⚠️ Add **only the tests you actually ran** below, and ensure **all items are checked ([x])**.
46
+ > Do not include tests you didn’t run.
46
47
 
47
- - [ ] Unit tests passed
48
- - [ ] Integration tests completed
48
+ ### Tests Run
49
49
 
50
- ### Execution Results
50
+ - [x] `{test command 1}` — PASS
51
+ - [x] `{test command 2}` — PASS
51
52
 
52
- - Command: `{test command executed}`
53
- - Result: `{PASS/FAIL summary}`
53
+ ### Notes (Optional)
54
+
55
+ - {extra context or links to logs}
56
+
57
+ > - If this includes UI changes, include **screenshots**.
58
+ > - If this includes logic/structure changes, include a **diagram**.
54
59
 
55
60
  ## Screenshots (Frontend / UI changes)
56
61
 
@@ -32,14 +32,17 @@ Guide for creating Pull Requests.
32
32
 
33
33
  1. Run relevant test commands (e.g., `npm test`, `pnpm test`); if no tests exist, request them from the user
34
34
  2. Check results (PASS/FAIL)
35
- 3. Record **execution results** in the "Tests" section of PR body
36
- 4. All checkboxes must be checked
35
+ 3. In the PR body "Tests" section, add **only the tests you actually ran** as checklist items and ensure they are **all checked ([x])** (do not include unexecuted tests)
36
+ 4. If you didn’t run any tests, request/confirm with the user before creating the PR
37
37
 
38
38
  ### 3. Prepare Screenshots / Diagrams (Include in PR Body)
39
39
 
40
40
  Include the artifacts in the PR body.
41
41
 
42
- #### Frontend PR (UI changes)
42
+ > - If this includes UI changes, include **screenshots**.
43
+ > - If this includes logic/structure changes, include a **diagram**.
44
+
45
+ #### UI changes (Frontend PR)
43
46
 
44
47
  - Use `agent-browser` to generate screenshots.
45
48
  - Save files under a local temp folder (`/tmp/lee-spec-kit/pr-assets/`).
@@ -54,7 +57,8 @@ agent-browser install # install Playwright browsers
54
57
  # - If you already have a running dev server, you can just set PREVIEW_URL to that URL.
55
58
  PORT=$(node -e "const net=require('net');const s=net.createServer();s.listen(0,'127.0.0.1',()=>{console.log(s.address().port);s.close();});")
56
59
  # (example) Vite
57
- pnpm dev --host 127.0.0.1 --port \"$PORT\"
60
+ pnpm dev --host 127.0.0.1 --port \"$PORT\" >/tmp/lee-spec-kit-dev.log 2>&1 &
61
+ DEV_PID=$!
58
62
  PREVIEW_URL=\"http://127.0.0.1:${PORT}\"
59
63
 
60
64
  # (example) capture from a preview URL
@@ -62,6 +66,9 @@ mkdir -p /tmp/lee-spec-kit/pr-assets
62
66
  agent-browser open "$PREVIEW_URL"
63
67
  agent-browser screenshot /tmp/lee-spec-kit/pr-assets/ui-1.png --full
64
68
  agent-browser close
69
+
70
+ # (recommended) stop the dev server you started for screenshots
71
+ kill \"$DEV_PID\" >/dev/null 2>&1 || true
65
72
  ```
66
73
 
67
74
  ```bash
@@ -78,7 +85,7 @@ gh release upload "$TAG" /tmp/lee-spec-kit/pr-assets/* --clobber
78
85
  echo \"![](https://github.com/${REPO}/releases/download/${TAG}/ui-1.png)\"
79
86
  ```
80
87
 
81
- #### Backend PR (Core structure)
88
+ #### Logic/structure changes (Backend PR)
82
89
 
83
90
  - Write a Mermaid diagram (flowchart/sequence/etc.) in the PR body (see the "Architecture Diagram" section in `pr-template.md`).
84
91
 
@@ -15,7 +15,7 @@
15
15
  - **PR**: -
16
16
  - Example: `#123` or PR URL
17
17
  - **PR Status**: -
18
- - Values: Draft | Review | Approved
18
+ - Values: Review | Approved
19
19
 
20
20
  ---
21
21
 
@@ -15,7 +15,7 @@
15
15
  - **PR**: -
16
16
  - Example: `#123` or PR URL
17
17
  - **PR Status**: -
18
- - Values: Draft | Review | Approved
18
+ - Values: Review | Approved
19
19
 
20
20
  ---
21
21
 
@@ -40,15 +40,20 @@ PR 본문에서 레포 내 파일 링크는 **반드시 현재 브랜치명을
40
40
 
41
41
  ## 테스트
42
42
 
43
- > ⚠️ **실제 테스트 실행 체크하세요. 미실행 항목은 체크하지 마세요.**
43
+ > ⚠️ **실제로 실행한 테스트만** 아래에 항목을 추가하고, **모두 체크([x])** 하세요.
44
+ > 미실행 테스트는 항목을 만들지 않습니다.
44
45
 
45
- - [ ] 유닛 테스트 통과
46
- - [ ] 통합 테스트 완료
46
+ ### 실행한 테스트
47
47
 
48
- ### 실행 결과
48
+ - [x] `{테스트 명령어 1}` — PASS
49
+ - [x] `{테스트 명령어 2}` — PASS
49
50
 
50
- - 명령어: `{실행한 테스트 명령어}`
51
- - 결과: `{PASS/FAIL 요약}`
51
+ ### 로그/비고 (선택)
52
+
53
+ - {추가 설명 또는 로그 링크}
54
+
55
+ > - UI 변경에 해당된다면 **스크린샷을** 포함하세요.
56
+ > - 로직/구조 변경에 해당된다면 **다이어그램을** 포함하세요.
52
57
 
53
58
  ## 스크린샷 (프론트엔드 / UI 변경 시)
54
59
 
@@ -32,14 +32,17 @@ Pull Request를 생성할 때 따르는 가이드입니다.
32
32
 
33
33
  1. 작업과 관련된 테스트 명령어 실행 (예: `npm test`, `pnpm test`), 테스트가 없는 경우 사용자에게 요청
34
34
  2. 결과 확인 (PASS/FAIL)
35
- 3. PR 본문 "테스트" 섹션에 **실행 결과** 기록
36
- 4. 모든 체크박스가 체크되어야
35
+ 3. PR 본문 "테스트" 섹션에 **실행한 테스트만** 체크리스트로 추가하고, **모두 체크([x])** 합니다. (미실행 항목은 작성하지 않기)
36
+ 4. 테스트를 실행하지 않았다면, PR 생성 전에 사용자에게 요청/확인합니다.
37
37
 
38
38
  ### 3. 스크린샷/다이어그램 작성 (PR 본문에 포함)
39
39
 
40
40
  PR 본문에 결과물을 포함합니다.
41
41
 
42
- #### 프론트엔드 PR (UI 변경)
42
+ > - UI 변경에 해당된다면 **스크린샷을** 포함하세요.
43
+ > - 로직/구조 변경에 해당된다면 **다이어그램을** 포함하세요.
44
+
45
+ #### UI 변경 (프론트엔드 PR)
43
46
 
44
47
  - `agent-browser`로 스크린샷을 생성합니다.
45
48
  - 스크린샷 파일은 로컬 임시 폴더(`/tmp/lee-spec-kit/pr-assets/`)에 저장합니다.
@@ -54,7 +57,8 @@ agent-browser install # Playwright 브라우저 설치
54
57
  # - 이미 떠있는 개발 서버가 있다면 그 URL을 PREVIEW_URL로 지정해도 됩니다.
55
58
  PORT=$(node -e "const net=require('net');const s=net.createServer();s.listen(0,'127.0.0.1',()=>{console.log(s.address().port);s.close();});")
56
59
  # (예시) Vite
57
- pnpm dev --host 127.0.0.1 --port \"$PORT\"
60
+ pnpm dev --host 127.0.0.1 --port \"$PORT\" >/tmp/lee-spec-kit-dev.log 2>&1 &
61
+ DEV_PID=$!
58
62
  PREVIEW_URL=\"http://127.0.0.1:${PORT}\"
59
63
 
60
64
  # (예시) 미리보기 URL을 정해 스크린샷 생성
@@ -62,6 +66,9 @@ mkdir -p /tmp/lee-spec-kit/pr-assets
62
66
  agent-browser open "$PREVIEW_URL"
63
67
  agent-browser screenshot /tmp/lee-spec-kit/pr-assets/ui-1.png --full
64
68
  agent-browser close
69
+
70
+ # (권장) 스크린샷을 위해 띄운 개발 서버는 작업이 끝나면 종료합니다.
71
+ kill \"$DEV_PID\" >/dev/null 2>&1 || true
65
72
  ```
66
73
 
67
74
  ```bash
@@ -78,7 +85,7 @@ gh release upload "$TAG" /tmp/lee-spec-kit/pr-assets/* --clobber
78
85
  echo \"![](https://github.com/${REPO}/releases/download/${TAG}/ui-1.png)\"
79
86
  ```
80
87
 
81
- #### 백엔드 PR (핵심 구조)
88
+ #### 로직/구조 변경 (백엔드 PR)
82
89
 
83
90
  - PR 본문에 Mermaid 다이어그램(예: flowchart/sequence)을 작성합니다. (`pr-template.md`의 "아키텍처 다이어그램" 섹션 참고)
84
91
 
@@ -15,7 +15,7 @@
15
15
  - **PR**: -
16
16
  - 예: `#123` 또는 PR URL
17
17
  - **PR 상태**: -
18
- - 값: Draft | Review | Approved
18
+ - 값: Review | Approved
19
19
 
20
20
  ---
21
21
 
@@ -15,7 +15,7 @@
15
15
  - **PR**: -
16
16
  - 예: `#123` 또는 PR URL
17
17
  - **PR 상태**: -
18
- - 값: Draft | Review | Approved
18
+ - 값: Review | Approved
19
19
 
20
20
  ---
21
21