@txstack/dev-guide 0.1.0 → 0.1.2
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/CHANGELOG.md +13 -1
- package/README.md +69 -50
- package/llms.txt +5 -5
- package/package.json +2 -2
- package/templates/DEV_GUIDE_DIFF.md +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,8 +1,20 @@
|
|
|
1
1
|
# @txstack/dev-guide
|
|
2
2
|
|
|
3
|
+
## 0.1.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- npm 의 홈페이지 링크가 문서 사이트의 Dev Guide 페이지(`https://code7004.github.io/txstack/docs/dev-guide`)로 간다. 내용은 바뀌지 않았다.
|
|
8
|
+
|
|
9
|
+
## 0.1.1
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- 11737d8: README 를 다른 패키지와 같은 '습니다' 체로 다듬었다 — 무엇을 제공하고 어디에 쓰는지부터 소개하고, 적용 절차를 1~5 단계로 정리했다. 업데이트 절차에서 새 버전의 CHANGELOG 는 설치 전에 저장소에서 먼저 확인하도록 순서를 바로잡았다. 차이점 템플릿의 "따르는 판" 을 "적용 버전" 으로 바꿨다. 규칙은 바뀌지 않았다.
|
|
14
|
+
|
|
3
15
|
## 0.1.0
|
|
4
16
|
|
|
5
|
-
첫
|
|
17
|
+
첫 버전. 버전 정책과 업데이트 절차는 [README](README.md) 「업데이트하기」.
|
|
6
18
|
|
|
7
19
|
- `rules/` — 실행 스크립트 이름 · 커밋 · 작업 공간 · 코드
|
|
8
20
|
- `process/` — docs 여섯 칸 구조 · 요구사항 → 계획 → 구현 → 검증 → 보고 · 사람과 AI 의 몫
|
package/README.md
CHANGED
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
# @txstack/dev-guide
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
실행 스크립트
|
|
5
|
-
|
|
3
|
+
프로젝트마다 반복해서 정리하던 개발 규칙과 문서 양식을 한곳에 모은 패키지입니다.
|
|
4
|
+
실행 스크립트 이름, 코드 작성, 커밋 규칙과 함께 요구사항 정리부터 계획 · 구현 · 검증 · 보고까지
|
|
5
|
+
이어지는 작업 절차를 제공합니다.
|
|
6
|
+
|
|
7
|
+
새 프로젝트를 시작하거나 여러 저장소의 개발 기준을 맞출 때 사용할 수 있습니다.
|
|
8
|
+
공통 규칙은 설치된 패키지에서 확인하고, 프로젝트별로 다르게 적용하는 내용만 별도 문서에 기록합니다.
|
|
9
|
+
Claude Code 나 Codex 같은 AI 코딩 도구에도 같은 기준을 안내할 수 있습니다.
|
|
10
|
+
|
|
11
|
+
마크다운 문서와 템플릿으로 구성되어 있으며, 런타임 코드나 의존성은 없습니다.
|
|
6
12
|
|
|
7
13
|
## 설치
|
|
8
14
|
|
|
@@ -14,19 +20,21 @@ pnpm add -D @txstack/dev-guide # 일반 저장소
|
|
|
14
20
|
pnpm add -D -w @txstack/dev-guide # pnpm 모노레포 — 루트에 한 번
|
|
15
21
|
```
|
|
16
22
|
|
|
17
|
-
|
|
23
|
+
개발 가이드는 패키지에 포함되어 있어, 설치한 버전의 규칙과 양식을 그대로 확인할 수 있습니다.
|
|
24
|
+
버전별 변경 내용은 함께 설치되는 [CHANGELOG.md](CHANGELOG.md) 에서 확인할 수 있습니다.
|
|
18
25
|
|
|
19
|
-
##
|
|
26
|
+
## 프로젝트에 적용하기
|
|
20
27
|
|
|
21
|
-
|
|
28
|
+
설치만으로 규칙이 적용되지는 않습니다. 아래 순서로 문서를 준비하고 AI 도구의 지침에 연결합니다.
|
|
29
|
+
**기존 파일은 덮어쓰지 않습니다** — 이미 있는 파일은 경로를 알려 주므로, 템플릿과 비교해 필요한 내용을 반영하세요.
|
|
22
30
|
|
|
23
|
-
**1.
|
|
31
|
+
**1. 설치합니다** — 위의 [설치](#설치).
|
|
24
32
|
|
|
25
|
-
**2
|
|
33
|
+
**2. 저장소 루트에서 문서 폴더와 기본 파일을 만듭니다.**
|
|
26
34
|
|
|
27
35
|
```sh
|
|
28
36
|
G=node_modules/@txstack/dev-guide/templates
|
|
29
|
-
put() { if [ -e "$2" ]; then echo "
|
|
37
|
+
put() { if [ -e "$2" ]; then echo "기존 파일이 있어 생성을 건너뜁니다 — 템플릿과 비교해 반영하세요: $2"; else cp "$G/$1" "$2"; fi; }
|
|
30
38
|
mkdir -p docs/project docs/rules docs/requirements docs/plans docs/verification docs/reports
|
|
31
39
|
put docs-README.md docs/README.md
|
|
32
40
|
put CURRENT.md CURRENT.md
|
|
@@ -36,11 +44,13 @@ put DEV_GUIDE_DIFF.md docs/rules/00_DEV_GUIDE_DIFF.md
|
|
|
36
44
|
put rule.md docs/project/01_PROJECT_OVERVIEW.md
|
|
37
45
|
```
|
|
38
46
|
|
|
39
|
-
**
|
|
40
|
-
`docs/rules/00_DEV_GUIDE_DIFF.md` 의
|
|
47
|
+
**3. 프로젝트 정보를 입력합니다.** `<…>` 표시를 프로젝트에 맞는 내용으로 바꾸세요 — `CURRENT.md` 의 현재 상태,
|
|
48
|
+
`docs/project/01_PROJECT_OVERVIEW.md` 의 서비스 소개, `docs/rules/00_DEV_GUIDE_DIFF.md` 의 **적용 버전**(설치한 버전).
|
|
49
|
+
공통 규칙과 다르게 적용할 내용이 없다면 차이점 문서의 예시 행을 지우고 표를 비워 두세요.
|
|
41
50
|
|
|
42
|
-
**
|
|
43
|
-
|
|
51
|
+
**4. AI 도구의 프로젝트 지침을 설정합니다.** Claude Code 는 `CLAUDE.md`, Codex 는 `AGENTS.md` 를 읽습니다.
|
|
52
|
+
새로 만든 파일은 `<…>` 만 채우면 됩니다. 기존 파일이라면 맨 위에 아래 문단을 추가하세요.
|
|
53
|
+
`@txstack/ui` 를 사용한다면 그 아래에 `@txstack/ui` 의 `ai/rules.md` 「소비자 프로젝트 시작 묶음」 문단도 함께 추가할 수 있습니다.
|
|
44
54
|
|
|
45
55
|
```md
|
|
46
56
|
## 개발 기준
|
|
@@ -50,7 +60,8 @@ UI 를 `@txstack/ui` 로 짓는다면 그 아래에 `@txstack/ui` 의 `ai/rules.
|
|
|
50
60
|
dev-guide 와 다르게 하는 것은 [docs/rules/00_DEV_GUIDE_DIFF.md](docs/rules/00_DEV_GUIDE_DIFF.md) 에만 적는다.
|
|
51
61
|
```
|
|
52
62
|
|
|
53
|
-
**
|
|
63
|
+
**5. 첫 작업 문서를 작성합니다.** 작업 번호와 이름을 정하고 요구사항 · 계획 · 검증 템플릿을 복사한 뒤,
|
|
64
|
+
`docs/README.md` 의 「작업」 링크를 그 이름으로 바꾸세요.
|
|
54
65
|
|
|
55
66
|
```sh
|
|
56
67
|
G=node_modules/@txstack/dev-guide/templates
|
|
@@ -60,50 +71,55 @@ cp "$G/plan.md" "docs/plans/$n.md"
|
|
|
60
71
|
cp "$G/verification.md" "docs/verification/$n.md"
|
|
61
72
|
```
|
|
62
73
|
|
|
63
|
-
|
|
74
|
+
템플릿 안의 `nnn_title.md` 링크도 같은 이름으로 바꿉니다. 문서별 작성 시점과 역할은 [process/workflow.md](process/workflow.md) 에서 확인할 수 있습니다.
|
|
64
75
|
|
|
65
|
-
|
|
76
|
+
**공통 규칙은 패키지를 참조하고, 프로젝트별 예외만 기록하세요.** 규칙을 프로젝트 문서에 복사해 관리하면
|
|
77
|
+
패키지를 업데이트해도 변경 사항이 반영되지 않습니다.
|
|
66
78
|
|
|
67
|
-
##
|
|
79
|
+
## 업데이트하기
|
|
68
80
|
|
|
69
|
-
|
|
81
|
+
패키지를 업데이트하면 AI 도구가 참조하는 개발 규칙도 함께 바뀝니다. 규칙이 바뀌는 업데이트는
|
|
82
|
+
프로젝트에 미치는 영향을 검토한 뒤 적용하세요.
|
|
70
83
|
|
|
71
|
-
1.
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
84
|
+
1. 업데이트할 버전의 [CHANGELOG](https://github.com/code7004/txstack/blob/main/packages/dev-guide/CHANGELOG.md) 를 저장소에서 먼저 확인합니다 —
|
|
85
|
+
설치된 `CHANGELOG.md` 에는 아직 새 버전의 기록이 없습니다
|
|
86
|
+
2. 기존 예외(`docs/rules/00_DEV_GUIDE_DIFF.md`)에 영향을 주거나 프로젝트의 규칙과 충돌하는 변경이 있는지 확인합니다
|
|
87
|
+
3. 스크립트 · 문서 구조 · 진행 중인 작업 · AI 지침에 미치는 영향을 확인합니다
|
|
88
|
+
4. 적용할 변경과 프로젝트별 예외를 정해 `00_DEV_GUIDE_DIFF.md` 에 날짜와 함께 기록합니다
|
|
89
|
+
5. 업데이트한 뒤 **적용 버전**을 고치고, 채택한 규칙에 맞게 프로젝트를 수정합니다.
|
|
90
|
+
함께 설치된 `CHANGELOG.md` 와 규칙 문서를 기준으로 다시 점검합니다
|
|
91
|
+
6. 관련 변경은 하나의 커밋으로 관리합니다 — 예: `chore: dev-guide 0.2.0 적용`
|
|
77
92
|
|
|
78
|
-
|
|
79
|
-
`CURRENT.md` · `docs/README.md` · `CLAUDE.md` 처럼 계속 쓰는 문서는
|
|
93
|
+
**프로젝트에 복사한 템플릿은 자동으로 업데이트되지 않습니다.** 새 작업부터 새 템플릿을 쓰고,
|
|
94
|
+
진행 중인 문서는 그대로 두어도 됩니다. `CURRENT.md` · `docs/README.md` · `CLAUDE.md` 처럼 계속 쓰는 문서는
|
|
95
|
+
새 템플릿과 비교해 필요한 내용만 반영하세요.
|
|
80
96
|
|
|
81
|
-
###
|
|
97
|
+
### 버전 정책
|
|
82
98
|
|
|
83
|
-
|
|
|
84
|
-
| ------------- |
|
|
85
|
-
| patch `0.1.x` | 문구 · 오타 · 예시.
|
|
86
|
-
| minor `0.x.0` |
|
|
99
|
+
| 버전 | 바뀌는 것 | 적용 절차 |
|
|
100
|
+
| ------------- | ------------------------------------------------------- | --------------------- |
|
|
101
|
+
| patch `0.1.x` | 문구 · 오타 · 예시. 규칙을 적용하는 방법은 그대로입니다 | 별도 영향 검토 불필요 |
|
|
102
|
+
| minor `0.x.0` | 규칙의 추가 · 변경 · 삭제, 템플릿 구조 변경 | **영향 검토 후 적용** |
|
|
87
103
|
|
|
88
|
-
1.0 이후에는
|
|
104
|
+
1.0 이후에는 기존 규칙의 변경 · 삭제는 major, 규칙 추가는 minor, 문구 수정은 patch 버전으로 배포합니다.
|
|
89
105
|
|
|
90
|
-
##
|
|
106
|
+
## 문서
|
|
91
107
|
|
|
92
|
-
|
|
|
93
|
-
| ------------------------------------------------------ |
|
|
94
|
-
| [rules/scripts.md](rules/scripts.md) | 실행 스크립트 이름 — `<동작>:<대상>[:<변형>]`, `dev` · `start` 의 뜻
|
|
95
|
-
| [rules/commits.md](rules/commits.md) | Conventional Commits + 한글 · 커밋 단위 · 브랜치 · 커밋 훅
|
|
96
|
-
| [rules/workspace.md](rules/workspace.md) | pnpm · Node 고정 · `apps/` 와 `packages/` · 의존성 · 환경 변수
|
|
97
|
-
| [rules/code.md](rules/code.md) | 파일 · 이름 · TypeScript · import · 화면 · 서버 · 주석 · 테스트
|
|
98
|
-
| [process/docs-structure.md](process/docs-structure.md) |
|
|
99
|
-
| [process/workflow.md](process/workflow.md) | 요구사항 → 계획 → 구현 → 검증(QA) → 보고,
|
|
100
|
-
| [process/agents.md](process/agents.md) |
|
|
101
|
-
| [llms.txt](llms.txt) | AI
|
|
102
|
-
| [CHANGELOG.md](CHANGELOG.md) |
|
|
108
|
+
| 문서 | 내용 |
|
|
109
|
+
| ------------------------------------------------------ | ---------------------------------------------------------------------- |
|
|
110
|
+
| [rules/scripts.md](rules/scripts.md) | 실행 스크립트 이름 — `<동작>:<대상>[:<변형>]`, `dev` · `start` 의 뜻 |
|
|
111
|
+
| [rules/commits.md](rules/commits.md) | Conventional Commits + 한글 · 커밋 단위 · 브랜치 · 커밋 훅 |
|
|
112
|
+
| [rules/workspace.md](rules/workspace.md) | pnpm · Node 고정 · `apps/` 와 `packages/` · 의존성 · 환경 변수 |
|
|
113
|
+
| [rules/code.md](rules/code.md) | 파일 · 이름 · TypeScript · import · 화면 · 서버 · 주석 · 테스트 |
|
|
114
|
+
| [process/docs-structure.md](process/docs-structure.md) | docs 폴더 구성 · 파일 이름과 번호 · `CURRENT.md` · 색인 |
|
|
115
|
+
| [process/workflow.md](process/workflow.md) | 요구사항 → 계획 → 구현 → 검증(QA) → 보고, 단계별 시작 조건과 완료 기준 |
|
|
116
|
+
| [process/agents.md](process/agents.md) | 사용자와 AI 도구의 역할 · 다시 제안하기 · 증거로 말하기 |
|
|
117
|
+
| [llms.txt](llms.txt) | AI 도구가 먼저 읽는 목차 |
|
|
118
|
+
| [CHANGELOG.md](CHANGELOG.md) | 버전별 규칙 변경 내역 |
|
|
103
119
|
|
|
104
|
-
##
|
|
120
|
+
## 문서 템플릿
|
|
105
121
|
|
|
106
|
-
|
|
|
122
|
+
| 문서 템플릿 | 복사할 위치 |
|
|
107
123
|
| ------------------------------------------------ | ----------------------------------------------------- |
|
|
108
124
|
| [requirements.md](templates/requirements.md) | `docs/requirements/nnn_title.md` |
|
|
109
125
|
| [plan.md](templates/plan.md) | `docs/plans/nnn_title.md` |
|
|
@@ -115,10 +131,13 @@ cp "$G/verification.md" "docs/verification/$n.md"
|
|
|
115
131
|
| [CLAUDE.md](templates/CLAUDE.md) | 저장소 루트 `CLAUDE.md` · `AGENTS.md` |
|
|
116
132
|
| [DEV_GUIDE_DIFF.md](templates/DEV_GUIDE_DIFF.md) | `docs/rules/00_DEV_GUIDE_DIFF.md` |
|
|
117
133
|
|
|
118
|
-
##
|
|
134
|
+
## 제공 범위
|
|
135
|
+
|
|
136
|
+
업무 도메인, 서버 구성, 클라우드별 운영 절차는 포함하지 않습니다. 해당 내용은 각 프로젝트의
|
|
137
|
+
`docs/project/` 또는 `docs/rules/` 에서 관리합니다.
|
|
138
|
+
|
|
139
|
+
UI 컴포넌트 선택과 사용 규칙은 `@txstack/ui` 의 AI Guide(`ai/rules.md`)에서 별도로 제공합니다.
|
|
119
140
|
|
|
120
|
-
|
|
121
|
-
**화면 부품을 고르는 규칙**도 담지 않는다 — `@txstack/ui` 의 `ai/rules.md` 가 갖는다.
|
|
122
|
-
eslint · prettier · commitlint 설정 프리셋은 다음 판에 서브패스로 더한다.
|
|
141
|
+
ESLint · Prettier · commitlint 설정 프리셋은 현재 제공하지 않습니다. 후속 단계에서 검토할 예정입니다.
|
|
123
142
|
|
|
124
143
|
MIT
|
package/llms.txt
CHANGED
|
@@ -12,9 +12,9 @@
|
|
|
12
12
|
|
|
13
13
|
## 프로세스
|
|
14
14
|
|
|
15
|
-
- [process/docs-structure.md](process/docs-structure.md): docs
|
|
16
|
-
- [process/workflow.md](process/workflow.md): 작업 번호가 필요한가, 요구사항 → 계획 → 구현 → 검증(QA) →
|
|
17
|
-
- [process/agents.md](process/agents.md):
|
|
15
|
+
- [process/docs-structure.md](process/docs-structure.md): docs 폴더 구성(project · rules · requirements · plans · verification · reports), NN_TITLE.md 와 nnn_title.md, 작업 번호 공유, CURRENT.md, 색인
|
|
16
|
+
- [process/workflow.md](process/workflow.md): 작업 번호가 필요한가, 요구사항 → 계획 → 구현 → 검증(QA) → 보고, 단계별 시작 조건과 완료 기준
|
|
17
|
+
- [process/agents.md](process/agents.md): 사용자와 AI 도구의 역할, 판단이 필요하면 멈추고 묻는다, 그대로 따르지 않고 다시 제안한다, 증거로 말한다, 시작 문장
|
|
18
18
|
|
|
19
19
|
## 양식
|
|
20
20
|
|
|
@@ -28,6 +28,6 @@
|
|
|
28
28
|
- [templates/CLAUDE.md](templates/CLAUDE.md): 저장소 루트 — AI 도구가 먼저 읽는 문서
|
|
29
29
|
- [templates/DEV_GUIDE_DIFF.md](templates/DEV_GUIDE_DIFF.md): docs/rules/00_DEV_GUIDE_DIFF.md — dev-guide 와 다른 점
|
|
30
30
|
|
|
31
|
-
##
|
|
31
|
+
## 버전
|
|
32
32
|
|
|
33
|
-
- [CHANGELOG.md](CHANGELOG.md):
|
|
33
|
+
- [CHANGELOG.md](CHANGELOG.md): 버전별 규칙 변경 내역. 업데이트 절차와 버전 정책은 README 「업데이트하기」
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@txstack/dev-guide",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "Shared development guide — script naming, code and commit rules, a document-driven workflow (requirements → plans → verification → reports) and document templates",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"conventions",
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
"url": "git+https://github.com/code7004/txstack.git",
|
|
17
17
|
"directory": "packages/dev-guide"
|
|
18
18
|
},
|
|
19
|
-
"homepage": "https://github.
|
|
19
|
+
"homepage": "https://code7004.github.io/txstack/docs/dev-guide",
|
|
20
20
|
"bugs": "https://github.com/code7004/txstack/issues",
|
|
21
21
|
"files": [
|
|
22
22
|
"README.md",
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> 언제 보나: dev-guide 의 규칙이 이 프로젝트에서 그대로인지 확인할 때.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
적용 버전: `@txstack/dev-guide` <0.x.y>. **여기 없는 것은 dev-guide 그대로다.**
|
|
6
6
|
|
|
7
7
|
| dev-guide 규칙 | 이 프로젝트 | 이유 · 결정 |
|
|
8
8
|
| ----------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- |
|