lee-spec-kit 0.1.0
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/LICENSE +21 -0
- package/README.md +112 -0
- package/dist/index.js +461 -0
- package/package.json +60 -0
- package/templates/en/fullstack/README.md +12 -0
- package/templates/en/fullstack/agents/agents.md +88 -0
- package/templates/en/fullstack/agents/constitution.md +75 -0
- package/templates/en/fullstack/agents/git-workflow.md +112 -0
- package/templates/en/fullstack/agents/issue-template.md +58 -0
- package/templates/en/fullstack/agents/pr-template.md +57 -0
- package/templates/en/fullstack/features/README.md +76 -0
- package/templates/en/fullstack/features/be/README.md +5 -0
- package/templates/en/fullstack/features/fe/README.md +5 -0
- package/templates/en/fullstack/features/feature-base/decisions.md +15 -0
- package/templates/en/fullstack/features/feature-base/plan.md +49 -0
- package/templates/en/fullstack/features/feature-base/spec.md +55 -0
- package/templates/en/fullstack/features/feature-base/tasks.md +33 -0
- package/templates/en/fullstack/prd/README.md +15 -0
- package/templates/en/single/README.md +11 -0
- package/templates/en/single/agents/agents.md +74 -0
- package/templates/en/single/agents/constitution.md +75 -0
- package/templates/en/single/agents/git-workflow.md +157 -0
- package/templates/en/single/agents/issue-template.md +60 -0
- package/templates/en/single/agents/pr-template.md +71 -0
- package/templates/en/single/features/README.md +56 -0
- package/templates/en/single/features/feature-base/decisions.md +15 -0
- package/templates/en/single/features/feature-base/plan.md +48 -0
- package/templates/en/single/features/feature-base/spec.md +55 -0
- package/templates/en/single/features/feature-base/tasks.md +33 -0
- package/templates/en/single/prd/README.md +15 -0
- package/templates/ko/fullstack/README.md +12 -0
- package/templates/ko/fullstack/agents/agents.md +125 -0
- package/templates/ko/fullstack/agents/constitution.md +75 -0
- package/templates/ko/fullstack/agents/git-workflow.md +157 -0
- package/templates/ko/fullstack/agents/issue-template.md +60 -0
- package/templates/ko/fullstack/agents/pr-template.md +71 -0
- package/templates/ko/fullstack/features/README.md +98 -0
- package/templates/ko/fullstack/features/be/README.md +5 -0
- package/templates/ko/fullstack/features/fe/README.md +5 -0
- package/templates/ko/fullstack/features/feature-base/decisions.md +15 -0
- package/templates/ko/fullstack/features/feature-base/plan.md +49 -0
- package/templates/ko/fullstack/features/feature-base/spec.md +55 -0
- package/templates/ko/fullstack/features/feature-base/tasks.md +33 -0
- package/templates/ko/fullstack/prd/README.md +15 -0
- package/templates/ko/single/README.md +11 -0
- package/templates/ko/single/agents/agents.md +87 -0
- package/templates/ko/single/agents/constitution.md +75 -0
- package/templates/ko/single/agents/git-workflow.md +157 -0
- package/templates/ko/single/agents/issue-template.md +60 -0
- package/templates/ko/single/agents/pr-template.md +71 -0
- package/templates/ko/single/features/README.md +56 -0
- package/templates/ko/single/features/feature-base/decisions.md +15 -0
- package/templates/ko/single/features/feature-base/plan.md +48 -0
- package/templates/ko/single/features/feature-base/spec.md +55 -0
- package/templates/ko/single/features/feature-base/tasks.md +33 -0
- package/templates/ko/single/prd/README.md +15 -0
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
# Agents Guide
|
|
2
|
+
|
|
3
|
+
Operating rules for AI code assistants to perform consistent code generation and refactoring.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Reference Documents
|
|
8
|
+
|
|
9
|
+
### Core Documents
|
|
10
|
+
|
|
11
|
+
- **Project Principles**: `/docs/agents/constitution.md`
|
|
12
|
+
- **Git Workflow**: `/docs/agents/git-workflow.md`
|
|
13
|
+
- **Issue Template**: `/docs/agents/issue-template.md`
|
|
14
|
+
- **PR Template**: `/docs/agents/pr-template.md`
|
|
15
|
+
|
|
16
|
+
### PRD
|
|
17
|
+
|
|
18
|
+
- **Product Requirements**: `/docs/prd/`
|
|
19
|
+
|
|
20
|
+
### Features
|
|
21
|
+
|
|
22
|
+
- **BE Features**: `/docs/features/be/{feature-id}/`
|
|
23
|
+
- **FE Features**: `/docs/features/fe/{feature-id}/`
|
|
24
|
+
- **Template (SSOT)**: `/docs/features/feature-base/`
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## π Standard docs Structure
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
docs/
|
|
32
|
+
βββ README.md # Documentation guide
|
|
33
|
+
βββ agents/ # Agent operating rules
|
|
34
|
+
β βββ agents.md
|
|
35
|
+
β βββ constitution.md
|
|
36
|
+
β βββ git-workflow.md
|
|
37
|
+
β βββ issue-template.md
|
|
38
|
+
β βββ pr-template.md
|
|
39
|
+
βββ prd/ # Product requirements
|
|
40
|
+
βββ features/ # Feature documentation
|
|
41
|
+
β βββ be/ # Backend Features
|
|
42
|
+
β βββ fe/ # Frontend Features
|
|
43
|
+
βββ scripts/ # Utilities
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## Request Type Processes
|
|
49
|
+
|
|
50
|
+
### 1. New Feature Request
|
|
51
|
+
|
|
52
|
+
1. Identify target repo (BE or FE)
|
|
53
|
+
2. Create feature folder: `lee-spec-kit feature <name>`
|
|
54
|
+
3. Write `spec.md` - what and why (no tech stack)
|
|
55
|
+
4. Request spec review from user
|
|
56
|
+
5. Create GitHub Issue
|
|
57
|
+
|
|
58
|
+
### 2. Spec to Plan
|
|
59
|
+
|
|
60
|
+
1. Verify spec is clear
|
|
61
|
+
2. Write `plan.md` - tech stack, architecture, file structure
|
|
62
|
+
3. **Record key decisions in `decisions.md`** (required)
|
|
63
|
+
4. Decompose into tasks after user approval
|
|
64
|
+
|
|
65
|
+
### 3. Task Execution
|
|
66
|
+
|
|
67
|
+
1. Write tasks in `tasks.md`
|
|
68
|
+
2. Execute after user approval
|
|
69
|
+
3. Transition status: `[TODO]` β `[DOING]` β `[DONE]`
|
|
70
|
+
4. Commit immediately after task completion
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
## π ADR (Architecture Decision Records)
|
|
75
|
+
|
|
76
|
+
> `decisions.md` is a **required** document for recording technical decisions.
|
|
77
|
+
|
|
78
|
+
### Format
|
|
79
|
+
|
|
80
|
+
```markdown
|
|
81
|
+
## D{number}: {Decision Title} ({YYYY-MM-DD})
|
|
82
|
+
|
|
83
|
+
- **Context**: Problem situation or background
|
|
84
|
+
- **Options**: Alternatives considered
|
|
85
|
+
- **Decision**: Final choice
|
|
86
|
+
- **Rationale**: Reason for choice
|
|
87
|
+
- **Consequences**: Results and impact (optional)
|
|
88
|
+
```
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# {{projectName}} Constitution
|
|
2
|
+
|
|
3
|
+
Core principles and technical decision guidelines for the project.
|
|
4
|
+
All development decisions should be based on this document.
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Project Mission
|
|
9
|
+
|
|
10
|
+
> (Write your project mission here)
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Tech Stack
|
|
15
|
+
|
|
16
|
+
### Backend
|
|
17
|
+
|
|
18
|
+
| Technology | Version | Reason |
|
|
19
|
+
| -------------- | --------- | -------- |
|
|
20
|
+
| (e.g., NestJS) | (version) | (reason) |
|
|
21
|
+
|
|
22
|
+
### Frontend
|
|
23
|
+
|
|
24
|
+
| Technology | Version | Reason |
|
|
25
|
+
| ------------- | --------- | -------- |
|
|
26
|
+
| (e.g., React) | (version) | (reason) |
|
|
27
|
+
|
|
28
|
+
### Common
|
|
29
|
+
|
|
30
|
+
| Technology | Version | Reason |
|
|
31
|
+
| ----------------- | ------- | ------------------ |
|
|
32
|
+
| TypeScript | strict | Type safety |
|
|
33
|
+
| ESLint + Prettier | - | Code quality |
|
|
34
|
+
| pnpm | - | Package management |
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## Architecture Principles
|
|
39
|
+
|
|
40
|
+
### 1. Feature-Centric Management
|
|
41
|
+
|
|
42
|
+
- New features managed in `docs/features/F00X/` structure
|
|
43
|
+
- Develop by **feature unit** with FE/BE separation
|
|
44
|
+
- Workflow: spec β plan β tasks β decisions
|
|
45
|
+
|
|
46
|
+
### 2. (Additional Principles)
|
|
47
|
+
|
|
48
|
+
(Write project-specific architecture principles)
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
## Code Quality Standards
|
|
53
|
+
|
|
54
|
+
- TypeScript strict mode required
|
|
55
|
+
- ESLint + Prettier required
|
|
56
|
+
- Test coverage **80%+** for core business logic
|
|
57
|
+
- Components follow **single responsibility principle**
|
|
58
|
+
- Minimize code duplication
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
|
|
62
|
+
## Security Principles
|
|
63
|
+
|
|
64
|
+
- Manage secrets via environment variables (no repo commits)
|
|
65
|
+
- **Minimal** user data collection
|
|
66
|
+
- CORS configured for allowed origins only
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
## Language/Code Rules
|
|
71
|
+
|
|
72
|
+
- **AI Responses**: English
|
|
73
|
+
- **Code/Filenames**: English
|
|
74
|
+
- **Comments/Commits**: English
|
|
75
|
+
- **Date/Time**: User's PC system time (e.g., `{{date}}`)
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
# Git Workflow Guide
|
|
2
|
+
|
|
3
|
+
Rules for AI agents to automate Git/GitHub operations.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Core Concepts
|
|
8
|
+
|
|
9
|
+
| Concept | GitHub Mapping | Description |
|
|
10
|
+
| ---------------- | -------------- | ------------------------------- |
|
|
11
|
+
| Feature | GitHub Issue | Feature-level work unit |
|
|
12
|
+
| Task | Commit | Individual implementation unit |
|
|
13
|
+
| Feature Complete | Pull Request | Create PR on feature completion |
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## Branch Strategy
|
|
18
|
+
|
|
19
|
+
```
|
|
20
|
+
main
|
|
21
|
+
βββ feat/123-feature-name # Branch based on Issue #123
|
|
22
|
+
βββ commit 1: feat(#123): implement feature
|
|
23
|
+
βββ commit 2: test(#123): add tests
|
|
24
|
+
βββ commit 3: docs(#123): update docs
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### Branch Naming
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
{type}/{issue-number}-{feature-name}
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
| Type | Description |
|
|
34
|
+
| ---------- | ------------- |
|
|
35
|
+
| `feat` | New feature |
|
|
36
|
+
| `fix` | Bug fix |
|
|
37
|
+
| `refactor` | Refactoring |
|
|
38
|
+
| `docs` | Documentation |
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## Commit Convention
|
|
43
|
+
|
|
44
|
+
### Format
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
{type}(#{issue}): {description}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### Type List
|
|
51
|
+
|
|
52
|
+
| Type | Description | Example |
|
|
53
|
+
| ---------- | ------------- | ------------------------------------- |
|
|
54
|
+
| `feat` | New feature | `feat(#123): implement user auth` |
|
|
55
|
+
| `fix` | Bug fix | `fix(#123): fix login error` |
|
|
56
|
+
| `refactor` | Refactoring | `refactor(#123): separate auth logic` |
|
|
57
|
+
| `test` | Tests | `test(#123): add auth unit tests` |
|
|
58
|
+
| `docs` | Documentation | `docs(#123): clarify spec` |
|
|
59
|
+
| `style` | Code style | `style(#123): fix lint errors` |
|
|
60
|
+
| `chore` | Other | `chore(#123): update dependencies` |
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
## Automation Workflow
|
|
65
|
+
|
|
66
|
+
### 1. Feature Start
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
# 1. Create GitHub Issue (Feature = Issue)
|
|
70
|
+
# 2. Create branch
|
|
71
|
+
git checkout -b feat/{issue-number}-{feature-name}
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### 2. Auto Commit on Task Completion
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
git add .
|
|
78
|
+
git commit -m "{type}(#{issue}): {task-description}"
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### 3. Create PR on Feature Completion
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
git push origin feat/{issue-number}-{feature-name}
|
|
85
|
+
gh pr create --title "feat(#{issue}): {feature-title}" \
|
|
86
|
+
--body "Closes #{issue}" \
|
|
87
|
+
--base main
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### 4. Merge
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
git checkout main
|
|
94
|
+
git pull
|
|
95
|
+
gh pr merge --squash --delete-branch
|
|
96
|
+
git pull
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
## GitHub Setup Requirements
|
|
102
|
+
|
|
103
|
+
### Required
|
|
104
|
+
|
|
105
|
+
- [ ] GitHub CLI (`gh`) installed and authenticated
|
|
106
|
+
- [ ] Branch protection rules (main)
|
|
107
|
+
- Require PR before merging
|
|
108
|
+
|
|
109
|
+
### Recommended
|
|
110
|
+
|
|
111
|
+
- [ ] Auto-delete head branches
|
|
112
|
+
- [ ] Squash merging only
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# GitHub Issue Template Guide
|
|
2
|
+
|
|
3
|
+
Template for AI agents to create GitHub Issues.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Issue Creation Rules
|
|
8
|
+
|
|
9
|
+
### Title Format
|
|
10
|
+
|
|
11
|
+
```text
|
|
12
|
+
F{number}: {feature-name} ({short description})
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Example: `F001: user-auth (User authentication feature)`
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## Issue Body Template
|
|
20
|
+
|
|
21
|
+
```markdown
|
|
22
|
+
## Overview
|
|
23
|
+
|
|
24
|
+
{Brief description of the feature}
|
|
25
|
+
|
|
26
|
+
## Goals
|
|
27
|
+
|
|
28
|
+
- {Goal 1}
|
|
29
|
+
- {Goal 2}
|
|
30
|
+
|
|
31
|
+
## Completion Criteria
|
|
32
|
+
|
|
33
|
+
- [ ] {Criterion 1}
|
|
34
|
+
- [ ] {Criterion 2}
|
|
35
|
+
|
|
36
|
+
## Related Documents
|
|
37
|
+
|
|
38
|
+
- Spec: `docs/features/{be|fe}/F{number}-{feature-name}/spec.md`
|
|
39
|
+
|
|
40
|
+
## Labels
|
|
41
|
+
|
|
42
|
+
- `enhancement` (New feature)
|
|
43
|
+
- `bug` (Bug fix)
|
|
44
|
+
- `documentation` (Documentation)
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
## Label Rules
|
|
50
|
+
|
|
51
|
+
| Label | Usage |
|
|
52
|
+
| --------------- | ------------- |
|
|
53
|
+
| `enhancement` | New feature |
|
|
54
|
+
| `bug` | Bug fix |
|
|
55
|
+
| `documentation` | Documentation |
|
|
56
|
+
| `backend` | BE related |
|
|
57
|
+
| `frontend` | FE related |
|
|
58
|
+
| `priority:high` | High priority |
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# GitHub PR Template Guide
|
|
2
|
+
|
|
3
|
+
Template for AI agents to create Pull Requests.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## PR Creation Rules
|
|
8
|
+
|
|
9
|
+
### Title Format
|
|
10
|
+
|
|
11
|
+
```text
|
|
12
|
+
feat(#{issue-number}): {feature-name}
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Example: `feat(#1): Implement user authentication`
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## PR Body Template
|
|
20
|
+
|
|
21
|
+
```markdown
|
|
22
|
+
## Overview
|
|
23
|
+
|
|
24
|
+
{Brief description of changes}
|
|
25
|
+
|
|
26
|
+
## Changes
|
|
27
|
+
|
|
28
|
+
- {Change 1}
|
|
29
|
+
- {Change 2}
|
|
30
|
+
- {Change 3}
|
|
31
|
+
|
|
32
|
+
## Tests
|
|
33
|
+
|
|
34
|
+
- [ ] Unit tests passed
|
|
35
|
+
- [ ] Integration tests completed
|
|
36
|
+
|
|
37
|
+
## Screenshots (for UI changes)
|
|
38
|
+
|
|
39
|
+
{Attach if applicable}
|
|
40
|
+
|
|
41
|
+
## Related Documents
|
|
42
|
+
|
|
43
|
+
- Spec: `docs/features/{be|fe}/F{number}-{feature-name}/spec.md`
|
|
44
|
+
- Tasks: `docs/features/{be|fe}/F{number}-{feature-name}/tasks.md`
|
|
45
|
+
|
|
46
|
+
Closes #{issue-number}
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
## Merge Rules
|
|
52
|
+
|
|
53
|
+
| Situation | Merge Method |
|
|
54
|
+
| -------------- | ---------------- |
|
|
55
|
+
| Normal Feature | Squash and Merge |
|
|
56
|
+
| Urgent Hotfix | Merge or Rebase |
|
|
57
|
+
| Documentation | Squash and Merge |
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# Features Guide
|
|
2
|
+
|
|
3
|
+
Folder for managing feature specs, plans, and tasks.
|
|
4
|
+
**FE/BE repos are separated, so Features are also managed separately.**
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Folder Structure
|
|
9
|
+
|
|
10
|
+
```
|
|
11
|
+
features/
|
|
12
|
+
βββ README.md # This file
|
|
13
|
+
βββ feature-base/ # Shared template (edit in one place)
|
|
14
|
+
β βββ spec.md
|
|
15
|
+
β βββ plan.md
|
|
16
|
+
β βββ tasks.md
|
|
17
|
+
β βββ decisions.md
|
|
18
|
+
βββ be/ # Backend Features
|
|
19
|
+
β βββ F00X-{name}/
|
|
20
|
+
βββ fe/ # Frontend Features
|
|
21
|
+
βββ F00X-{name}/
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## Creating New Features
|
|
27
|
+
|
|
28
|
+
### Using CLI (Recommended)
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
# Backend Feature
|
|
32
|
+
lee-spec-kit feature --repo be user-auth
|
|
33
|
+
|
|
34
|
+
# Frontend Feature
|
|
35
|
+
lee-spec-kit feature --repo fe user-profile
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
> π‘ CLI copies templates from `feature-base/` and auto-assigns IDs.
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## Feature ID Rules
|
|
43
|
+
|
|
44
|
+
- `F{number}-{feature-name}` (e.g., F001-user-auth)
|
|
45
|
+
- Minimum **3-digit padding** for numbers (001, 002, ...)
|
|
46
|
+
- Expands to **4+ digits** beyond 999 (F1000, F1001, ...)
|
|
47
|
+
- Feature names in kebab-case
|
|
48
|
+
- **IDs are globally unique** across BE/FE (no duplicates)
|
|
49
|
+
- **Feature = Issue**: Each Feature corresponds to one GitHub Issue
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## Status Check
|
|
54
|
+
|
|
55
|
+
Check feature progress with CLI:
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
lee-spec-kit status
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Save to file:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
lee-spec-kit status --write
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
## File Roles
|
|
70
|
+
|
|
71
|
+
| File | Role | When to Write |
|
|
72
|
+
| -------------- | ------------------------- | ------------------- |
|
|
73
|
+
| `spec.md` | **What and Why** | Feature definition |
|
|
74
|
+
| `plan.md` | **How** (technical) | After spec approval |
|
|
75
|
+
| `tasks.md` | Specific work items | After plan approval |
|
|
76
|
+
| `decisions.md` | Technical decisions (ADR) | During development |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Decisions Log
|
|
2
|
+
|
|
3
|
+
Record technical decisions and their rationale.
|
|
4
|
+
|
|
5
|
+
> Format: `D{number}: {Decision Title} ({YYYY-MM-DD})`
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## D001: {Decision Title} ({YYYY-MM-DD})
|
|
10
|
+
|
|
11
|
+
- **Context**: Problem situation or background
|
|
12
|
+
- **Options**: Alternatives considered
|
|
13
|
+
- **Decision**: Final choice
|
|
14
|
+
- **Rationale**: Reason for choice
|
|
15
|
+
- **Consequences**: Results and impact (optional)
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# Implementation Plan: {κΈ°λ₯λͺ
}
|
|
2
|
+
|
|
3
|
+
> Write after spec is approved.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Overview
|
|
8
|
+
|
|
9
|
+
- **Feature ID**: F{λ²νΈ}
|
|
10
|
+
- **Target Repo**: {{projectName}}-{be|fe}
|
|
11
|
+
- **Created**: YYYY-MM-DD
|
|
12
|
+
- **Status**: Draft | Review | Approved
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## Tech Stack
|
|
17
|
+
|
|
18
|
+
| Category | Choice | Reason |
|
|
19
|
+
| -------- | ------ | ------ |
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## Architecture
|
|
24
|
+
|
|
25
|
+
(Component structure, data flow)
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## File Structure
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
src/
|
|
33
|
+
βββ ...
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## Test Strategy
|
|
39
|
+
|
|
40
|
+
- **Unit Tests**:
|
|
41
|
+
- **Integration Tests**:
|
|
42
|
+
- **E2E Tests**:
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## Related Documents
|
|
47
|
+
|
|
48
|
+
- Spec: [spec.md](./spec.md)
|
|
49
|
+
- Decisions: [decisions.md](./decisions.md)
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# Feature Spec: {κΈ°λ₯λͺ
}
|
|
2
|
+
|
|
3
|
+
> Tech stack is covered in plan.md.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Overview
|
|
8
|
+
|
|
9
|
+
- **Feature ID**: F{λ²νΈ}
|
|
10
|
+
- **Feature Name**: {κΈ°λ₯λͺ
}
|
|
11
|
+
- **Target Repo**: {{projectName}}-{be|fe}
|
|
12
|
+
- **Issue Number**: #{μ΄μλ²νΈ}
|
|
13
|
+
- **Created**: YYYY-MM-DD
|
|
14
|
+
- **Status**: Draft | Review | Approved
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## Purpose
|
|
19
|
+
|
|
20
|
+
(Why is this feature needed? What problem does it solve?)
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## User Stories
|
|
25
|
+
|
|
26
|
+
### US-1: {Story Title}
|
|
27
|
+
|
|
28
|
+
**As a** {user type}
|
|
29
|
+
**I want** {desired action}
|
|
30
|
+
**So that** {reason/value}
|
|
31
|
+
|
|
32
|
+
**Acceptance Criteria:**
|
|
33
|
+
|
|
34
|
+
- [ ] (verification condition)
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## Functional Requirements
|
|
39
|
+
|
|
40
|
+
### FR-1: {Requirement Title}
|
|
41
|
+
|
|
42
|
+
(Detailed description)
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## Non-Functional Requirements
|
|
47
|
+
|
|
48
|
+
- **Performance**:
|
|
49
|
+
- **Security**:
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## Related Documents
|
|
54
|
+
|
|
55
|
+
- PRD: `../../prd/`
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Tasks: {κΈ°λ₯λͺ
}
|
|
2
|
+
|
|
3
|
+
## Task Rules
|
|
4
|
+
|
|
5
|
+
- **Status**: `[TODO]` β `[DOING]` β `[DONE]`
|
|
6
|
+
- **Priority**: P0(urgent) > P1(high) > P2(medium) > P3(low)
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## GitHub Issue
|
|
11
|
+
|
|
12
|
+
- **Repo**: {{projectName}}-{be|fe}
|
|
13
|
+
- **Issue**: #{μ΄μλ²νΈ}
|
|
14
|
+
- **Branch**: `feat/{μ΄μλ²νΈ}-{κΈ°λ₯λͺ
}`
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## Task List
|
|
19
|
+
|
|
20
|
+
### Phase 1: {Phase Name}
|
|
21
|
+
|
|
22
|
+
- [TODO][P1] T-F{λ²νΈ}-01 {Task Title}
|
|
23
|
+
- Acceptance:
|
|
24
|
+
- (verification condition)
|
|
25
|
+
- Checklist:
|
|
26
|
+
- [ ] (subtask)
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## Completion Criteria
|
|
31
|
+
|
|
32
|
+
- [ ] All tasks [DONE]
|
|
33
|
+
- [ ] All tests passing
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# PRD (Product Requirements Document)
|
|
2
|
+
|
|
3
|
+
This folder contains product requirements documentation.
|
|
4
|
+
|
|
5
|
+
## Writing Guide
|
|
6
|
+
|
|
7
|
+
1. Define project overview and goals
|
|
8
|
+
2. Write main features and user stories
|
|
9
|
+
3. Include technical architecture overview
|
|
10
|
+
|
|
11
|
+
## Example Files
|
|
12
|
+
|
|
13
|
+
- `{project-name}-prd.md` - Main PRD document
|
|
14
|
+
- `backend-overview.md` - Backend architecture (optional)
|
|
15
|
+
- `frontend-overview.md` - Frontend architecture (optional)
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# {{projectName}} Documentation Guide
|
|
2
|
+
|
|
3
|
+
This documentation is organized by feature to help agents quickly understand the project.
|
|
4
|
+
|
|
5
|
+
## Directory Structure
|
|
6
|
+
|
|
7
|
+
| Path | Purpose | Key Documents |
|
|
8
|
+
| ---------------- | --------------------- | ------------------------------------------------------------- |
|
|
9
|
+
| `docs/agents/` | Agent operating rules | `agents.md`, `constitution.md`, `git-workflow.md` |
|
|
10
|
+
| `docs/prd/` | Product requirements | Project-specific |
|
|
11
|
+
| `docs/features/` | Feature documentation | `{feature-id}/spec.md`, `plan.md`, `tasks.md`, `decisions.md` |
|