lee-spec-kit 0.4.10 → 0.4.11

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.
Files changed (5) hide show
  1. package/package.json +1 -1
  2. package/templates/en/common/agents/pr-template.md +3 -0
  3. package/templates/en/common/agents/skills/create-pr.md +10 -3
  4. package/templates/ko/common/agents/pr-template.md +3 -0
  5. package/templates/ko/common/agents/skills/create-pr.md +10 -3
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.11",
4
4
  "description": "Project documentation structure generator for AI-assisted development",
5
5
  "type": "module",
6
6
  "bin": {
package/templates/en/common/agents/pr-template.md CHANGED
@@ -52,6 +52,9 @@ For file links within the repo in PR body, **always use current branch name**:
52
52
  - Command: `{test command executed}`
53
53
  - Result: `{PASS/FAIL summary}`
54
54
 
55
+ > - If this includes UI changes, include **screenshots**.
56
+ > - If this includes logic/structure changes, include a **diagram**.
57
+
55
58
  ## Screenshots (Frontend / UI changes)
56
59
 
57
60
  > If you follow the Release assets upload flow in `skills/create-pr.md`, you can include images in the PR body without committing files to your branch.
package/templates/en/common/agents/skills/create-pr.md CHANGED
@@ -39,7 +39,10 @@ Guide for creating Pull Requests.
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
 
package/templates/ko/common/agents/pr-template.md CHANGED
@@ -50,6 +50,9 @@ PR 본문에서 레포 내 파일 링크는 **반드시 현재 브랜치명을
50
50
  - 명령어: `{실행한 테스트 명령어}`
51
51
  - 결과: `{PASS/FAIL 요약}`
52
52
 
53
+ > - UI 변경에 해당된다면 **스크린샷을** 포함하세요.
54
+ > - 로직/구조 변경에 해당된다면 **다이어그램을** 포함하세요.
55
+
53
56
  ## 스크린샷 (프론트엔드 / UI 변경 시)
54
57
 
55
58
  > `skills/create-pr.md`의 Release assets 업로드 절차를 사용하면 브랜치에 파일을 커밋하지 않고도 이미지를 본문에 포함할 수 있습니다.
package/templates/ko/common/agents/skills/create-pr.md CHANGED
@@ -39,7 +39,10 @@ Pull Request를 생성할 때 따르는 가이드입니다.
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