aiwf 0.1.0 → 0.3.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/CHANGELOG.md +44 -0
- package/CLAUDE.md +220 -0
- package/LICENSE +1 -1
- package/README.ko.md +90 -62
- package/README.md +89 -62
- package/claude-code/{simone/.simone → aiwf/en/.aiwf}/01_PROJECT_DOCS/ARCHITECTURE.md +1 -1
- package/claude-code/{simone/.simone → aiwf/en/.aiwf}/02_REQUIREMENTS/M01_Backend_Setup/M01_milestone_meta.md +5 -1
- package/claude-code/{simone/.simone → aiwf/en/.aiwf}/02_REQUIREMENTS/M01_Backend_Setup/PRD_AMEND_01_Auth_Flow_Update.md +5 -1
- package/claude-code/{simone/.simone/03_SPRINTS/CLAUDE.MD → aiwf/en/.aiwf/03_SPRINTS/CLAUDE.md} +28 -7
- package/claude-code/{simone/.simone → aiwf/en/.aiwf}/03_SPRINTS/S01_M01_Initial_API/S01_sprint_meta.md +8 -1
- package/claude-code/{simone/.simone → aiwf/en/.aiwf}/03_SPRINTS/S01_M01_Initial_API/T01_S01_Setup_Project_Structure.md +5 -1
- package/claude-code/aiwf/en/.aiwf/04_GENERAL_TASKS/CLAUDE.md +96 -0
- package/claude-code/{simone/.simone → aiwf/en/.aiwf}/04_GENERAL_TASKS/T002_API_Rate_Limiting.md +7 -2
- package/claude-code/{simone/.simone → aiwf/en/.aiwf}/04_GENERAL_TASKS/TX001_Refactor_Logging_Module.md +7 -2
- package/claude-code/{simone/.simone → aiwf/en/.aiwf}/05_ARCHITECTURAL_DECISIONS/ADR001_Chosen_Database_System.md +7 -1
- package/claude-code/{simone/.simone → aiwf/en/.aiwf}/05_ARCHITECTURAL_DECISIONS/ADR002_API_Authentication_Method.md +7 -1
- package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/2025-06-12-12-00-needs-focus.md +139 -0
- package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/2025-06-12-12-00-test-alignment.md +155 -0
- package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/2025-06-13-00-50-solid-progress.md +122 -0
- package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/2025-06-14-08-30-infrastructure-challenges.md +141 -0
- package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/2025-06-16-21-48-critical-foundation-issues.md +177 -0
- package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/2025-06-17-15-08-solid-progress.md +149 -0
- package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/index.json +5 -0
- package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/sync-index.js +78 -0
- package/claude-code/aiwf/en/.aiwf/98_PROMPTS/github_integration.md +130 -0
- package/claude-code/aiwf/en/.aiwf/98_PROMPTS/useful-prompts.md +31 -0
- package/claude-code/aiwf/en/.aiwf/98_PROMPTS/vibe-front-prompts.md +89 -0
- package/claude-code/{simone/.simone → aiwf/en/.aiwf}/99_TEMPLATES/task_template.md +1 -0
- package/claude-code/{simone/.simone/CLAUDE.MD → aiwf/en/.aiwf/CLAUDE.md} +13 -4
- package/claude-code/{simone/.simone → aiwf/en/.aiwf}/README.md +6 -6
- package/claude-code/aiwf/en/.claude/CLAUDE_BE.md +276 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_changelog.md +82 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_code_review.md +88 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_commit.md +160 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_create_general_task.md +147 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_create_milestone_plan.md +194 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_create_prd.md +272 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_create_sprint_tasks.md +189 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_create_sprints_from_milestone.md +121 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_discuss_review.md +29 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_do_task.md +109 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_infinite.md +202 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_initialize.md +134 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_issue_create.md +65 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_mermaid.md +272 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_pr_create.md +76 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_prime.md +9 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_prime_context.md +5 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_project_review.md +261 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_test.md +125 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_testing_review.md +198 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_tm-run-all-subtask.md +206 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_ultrathink_code_advanced.md +460 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_ultrathink_code_basic.md +165 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_ultrathink_general.md +362 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_yolo.md +300 -0
- package/claude-code/aiwf/en/.claude/mcp.json +31 -0
- package/claude-code/aiwf/en/.claude/settings.json +102 -0
- package/claude-code/aiwf/ko/.aiwf/00_PROJECT_MANIFEST.md +49 -0
- package/claude-code/aiwf/ko/.aiwf/01_PROJECT_DOCS/ARCHITECTURE.md +55 -0
- package/claude-code/aiwf/ko/.aiwf/02_REQUIREMENTS/CLAUDE.md +78 -0
- package/claude-code/aiwf/ko/.aiwf/02_REQUIREMENTS/M01_Backend_Setup/M01_milestone_meta.md +42 -0
- package/claude-code/aiwf/ko/.aiwf/02_REQUIREMENTS/M01_Backend_Setup/PRD_AMEND_01_Auth_Flow_Update.md +73 -0
- package/claude-code/aiwf/ko/.aiwf/02_REQUIREMENTS/M01_Backend_Setup/PRD_Backend_Setup.md +98 -0
- package/claude-code/aiwf/ko/.aiwf/02_REQUIREMENTS/M01_Backend_Setup/SPECS_API_V1.md +232 -0
- package/claude-code/aiwf/ko/.aiwf/03_SPRINTS/CLAUDE.md +83 -0
- package/claude-code/aiwf/ko/.aiwf/03_SPRINTS/S01_M01_Initial_API/S01_sprint_meta.md +49 -0
- package/claude-code/aiwf/ko/.aiwf/03_SPRINTS/S01_M01_Initial_API/T01_S01_Setup_Project_Structure.md +60 -0
- package/claude-code/aiwf/ko/.aiwf/04_GENERAL_TASKS/CLAUDE.md +96 -0
- package/claude-code/aiwf/ko/.aiwf/04_GENERAL_TASKS/T002_API_Rate_Limiting.md +54 -0
- package/claude-code/aiwf/ko/.aiwf/04_GENERAL_TASKS/TX001_Refactor_Logging_Module.md +58 -0
- package/claude-code/aiwf/ko/.aiwf/05_ARCHITECTURAL_DECISIONS/ADR001_Chosen_Database_System.md +119 -0
- package/claude-code/aiwf/ko/.aiwf/05_ARCHITECTURAL_DECISIONS/ADR002_API_Authentication_Method.md +124 -0
- package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/2025-06-12-12-00-needs-focus.md +139 -0
- package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/2025-06-12-12-00-test-alignment.md +155 -0
- package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/2025-06-13-00-50-solid-progress.md +122 -0
- package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/2025-06-14-08-30-infrastructure-challenges.md +141 -0
- package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/2025-06-16-21-48-critical-foundation-issues.md +177 -0
- package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/2025-06-17-15-08-solid-progress.md +149 -0
- package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/index.json +5 -0
- package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/sync-index.js +78 -0
- package/claude-code/aiwf/ko/.aiwf/98_PROMPTS/github_integration.md +130 -0
- package/claude-code/aiwf/ko/.aiwf/98_PROMPTS/useful-prompts.md +31 -0
- package/claude-code/aiwf/ko/.aiwf/98_PROMPTS/vibe-front-prompts.md +89 -0
- package/claude-code/aiwf/ko/.aiwf/99_TEMPLATES/adr_template.md +49 -0
- package/claude-code/aiwf/ko/.aiwf/99_TEMPLATES/milestone_meta_template.md +25 -0
- package/claude-code/aiwf/ko/.aiwf/99_TEMPLATES/project_manifest_template.md +39 -0
- package/claude-code/aiwf/ko/.aiwf/99_TEMPLATES/sprint_meta_template.md +23 -0
- package/claude-code/aiwf/ko/.aiwf/99_TEMPLATES/task_template.md +36 -0
- package/claude-code/aiwf/ko/.aiwf/CLAUDE.md +76 -0
- package/claude-code/aiwf/ko/.aiwf/README.md +97 -0
- package/claude-code/aiwf/ko/.claude/CLAUDE_BE.md +276 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_changelog.md +82 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_code_review.md +88 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_commit.md +160 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_create_general_task.md +147 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_create_milestone_plan.md +194 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_create_prd.md +280 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_create_sprint_tasks.md +189 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_create_sprints_from_milestone.md +121 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_discuss_review.md +29 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_do_task.md +109 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_infinite.md +202 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_initialize.md +134 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_issue_create.md +65 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_mermaid.md +272 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_pr_create.md +76 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_prime.md +9 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_prime_context.md +8 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_project_review.md +261 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_test.md +125 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_testing_review.md +198 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_tm-run-all-subtask.md +210 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_ultrathink_code_advanced.md +460 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_ultrathink_code_basic.md +165 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_ultrathink_general.md +362 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_yolo.md +300 -0
- package/claude-code/aiwf/ko/.claude/mcp.json +31 -0
- package/claude-code/aiwf/ko/.claude/settings.json +102 -0
- package/{AI-WORKFLOW.md → docs/AI-WORKFLOW.ko.md} +31 -24
- package/docs/AI-WORKFLOW.md +292 -0
- package/docs/COMMANDS_GUIDE.ko.md +637 -0
- package/docs/COMMANDS_GUIDE.md +636 -0
- package/docs/CONTRIBUTING.md +406 -0
- package/docs/DEVELOPMENT_GUIDE.md +727 -0
- package/{PRD.ko.md → docs/PRD.ko.md} +9 -9
- package/{PRD.md → docs/PRD.md} +9 -9
- package/docs/moonklabs-metadata-system-prd.md +127 -0
- package/index.js +272 -121
- package/package.json +12 -7
- package/COMMANDS_GUIDE.md +0 -462
- package/claude-code/simone/.simone/04_GENERAL_TASKS/CLAUDE.MD +0 -51
- package/claude-code/simone/CHANGELOG.md +0 -71
- package/claude-code/simone/LICENSE +0 -21
- package/claude-code/simone/README.md +0 -219
- package/claude-code/simone/SYNC_GUIDE.md +0 -172
- package/claude-code/simone/sync-simone.sh +0 -138
- /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/00_PROJECT_MANIFEST.md +0 -0
- /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/02_REQUIREMENTS/CLAUDE.md +0 -0
- /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/02_REQUIREMENTS/M01_Backend_Setup/PRD_Backend_Setup.md +0 -0
- /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/02_REQUIREMENTS/M01_Backend_Setup/SPECS_API_V1.md +0 -0
- /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/99_TEMPLATES/adr_template.md +0 -0
- /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/99_TEMPLATES/milestone_meta_template.md +0 -0
- /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/99_TEMPLATES/project_manifest_template.md +0 -0
- /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/99_TEMPLATES/sprint_meta_template.md +0 -0
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
# AIWF 프레임워크 초기화
|
|
2
|
+
|
|
3
|
+
Initialize the AIWF project management framework through an adaptive, interactive process.
|
|
4
|
+
|
|
5
|
+
## Create a TODO with EXACTLY these items
|
|
6
|
+
|
|
7
|
+
1. Scan and analyze the project
|
|
8
|
+
2. Interactive confirmation with user
|
|
9
|
+
3. Check for existing AIWF documents
|
|
10
|
+
4. Guide document creation process
|
|
11
|
+
5. Create first milestone for AIWF
|
|
12
|
+
6. Generate project manifest
|
|
13
|
+
7. Provide next steps
|
|
14
|
+
|
|
15
|
+
## DETAILS on every TODO item
|
|
16
|
+
|
|
17
|
+
### 1. Scan and analyze the project
|
|
18
|
+
|
|
19
|
+
**Detect project characteristics:**
|
|
20
|
+
|
|
21
|
+
- Check for package.json, requirements.txt, composer.json, etc.
|
|
22
|
+
- Identify project type (Node.js, Python, PHP, etc.)
|
|
23
|
+
- Scan overall project structure
|
|
24
|
+
- Check if this is a new or existing project
|
|
25
|
+
- Look for existing documentation (README, docs/, etc.)
|
|
26
|
+
|
|
27
|
+
**Keep findings brief** - Just identify the essentials
|
|
28
|
+
|
|
29
|
+
### 2. Interactive confirmation with user
|
|
30
|
+
|
|
31
|
+
**Present findings conversationally:**
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
I found this to be a [project type] project named [detected name].
|
|
35
|
+
Is this correct? Should I proceed with AIWF setup?
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
**Get user confirmation before continuing**
|
|
39
|
+
|
|
40
|
+
### 3. Check for existing AIWF documents
|
|
41
|
+
|
|
42
|
+
**Scan .aiwf/ directory for:**
|
|
43
|
+
|
|
44
|
+
- Any documents in 01_PROJECT_DOCS/
|
|
45
|
+
- Any milestones in 02_REQUIREMENTS/
|
|
46
|
+
- Any existing sprints or tasks
|
|
47
|
+
- Current manifest status
|
|
48
|
+
|
|
49
|
+
**Interactive decision:**
|
|
50
|
+
|
|
51
|
+
- If documents found: "I found existing documents: [list]. Should we work with these or extend them?"
|
|
52
|
+
- If no documents: "No AIWF documents found yet. Do you have any existing project documentation you'd like to copy in before we continue?"
|
|
53
|
+
|
|
54
|
+
**Allow user to:**
|
|
55
|
+
|
|
56
|
+
- Use existing documents
|
|
57
|
+
- Add new documents
|
|
58
|
+
- Start fresh
|
|
59
|
+
- Cancel to add documents manually first
|
|
60
|
+
|
|
61
|
+
### 4. Guide document creation process
|
|
62
|
+
|
|
63
|
+
**Based on user's choice:**
|
|
64
|
+
|
|
65
|
+
**If starting fresh or extending:**
|
|
66
|
+
|
|
67
|
+
- Perform deep analysis of the codebase
|
|
68
|
+
- Identify key components and architecture patterns
|
|
69
|
+
- Create draft ARCHITECTURE.md based on analysis
|
|
70
|
+
- Use Q&A style to refine and complete:
|
|
71
|
+
- "What's the main purpose of this project?"
|
|
72
|
+
- "What are the key technical decisions?"
|
|
73
|
+
- "Any important constraints or requirements?"
|
|
74
|
+
|
|
75
|
+
**If using existing docs:**
|
|
76
|
+
|
|
77
|
+
- Import and adapt existing documentation
|
|
78
|
+
- Fill in any AIWF-specific sections
|
|
79
|
+
- Ensure compatibility with framework structure
|
|
80
|
+
|
|
81
|
+
**Keep it conversational and adaptive**
|
|
82
|
+
|
|
83
|
+
### 5. Create first milestone for AIWF
|
|
84
|
+
|
|
85
|
+
**Determine appropriate first milestone:**
|
|
86
|
+
|
|
87
|
+
- If new project: Start with setup/foundation milestone
|
|
88
|
+
- If existing project: Identify current phase and create appropriate milestone
|
|
89
|
+
|
|
90
|
+
**Interactive milestone creation:**
|
|
91
|
+
|
|
92
|
+
- "Based on the project state, I suggest creating milestone: [name]"
|
|
93
|
+
- "What would you like to focus on in this milestone?"
|
|
94
|
+
- Create milestone structure with initial requirements
|
|
95
|
+
- Keep scope realistic and focused
|
|
96
|
+
|
|
97
|
+
### 6. Generate project manifest
|
|
98
|
+
|
|
99
|
+
**Automatically generate manifest using:**
|
|
100
|
+
|
|
101
|
+
- Information gathered during setup
|
|
102
|
+
- Created/imported documentation
|
|
103
|
+
- Current milestone details
|
|
104
|
+
- Project metadata
|
|
105
|
+
|
|
106
|
+
**No user interaction needed** - Just inform when complete
|
|
107
|
+
|
|
108
|
+
### 7. Provide next steps
|
|
109
|
+
|
|
110
|
+
**Customized guidance based on setup:**
|
|
111
|
+
|
|
112
|
+
```
|
|
113
|
+
✅ AIWF initialized for [project name]!
|
|
114
|
+
|
|
115
|
+
Current setup:
|
|
116
|
+
- Project type: [type]
|
|
117
|
+
- Current milestone: [milestone]
|
|
118
|
+
- Documents: [created/imported]
|
|
119
|
+
|
|
120
|
+
Next steps:
|
|
121
|
+
- Review your architecture: 01_PROJECT_DOCS/ARCHITECTURE.md
|
|
122
|
+
- Check milestone requirements: 02_REQUIREMENTS/[milestone]/
|
|
123
|
+
- Start first task: /project:aiwf:create_general_task
|
|
124
|
+
|
|
125
|
+
Ready to begin development!
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
## ADAPTIVE PROCESS NOTES
|
|
129
|
+
|
|
130
|
+
- **Stay conversational** - Ask questions naturally, not like a form
|
|
131
|
+
- **Be smart** - Use AI to understand context and make intelligent suggestions
|
|
132
|
+
- **Allow flexibility** - User can skip, cancel, or modify at any point
|
|
133
|
+
- **Focus on value** - Only create what's useful for the specific project
|
|
134
|
+
- **Keep it simple** - Don't overwhelm with options or details
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# Create GitHub Issue from Task
|
|
2
|
+
|
|
3
|
+
Automatically create a GitHub issue based on a task file.
|
|
4
|
+
|
|
5
|
+
## Create TODO with EXACTLY these 5 items
|
|
6
|
+
|
|
7
|
+
1. Parse task file and extract information
|
|
8
|
+
2. Generate issue template
|
|
9
|
+
3. Create issue via GitHub API
|
|
10
|
+
4. Update task file with issue number
|
|
11
|
+
5. Report results
|
|
12
|
+
|
|
13
|
+
## 1 · Parse Task File
|
|
14
|
+
|
|
15
|
+
Get task ID from <$ARGUMENTS>:
|
|
16
|
+
- Sprint tasks: Search `.aiwf/03_SPRINTS/`
|
|
17
|
+
- General tasks: Search `.aiwf/04_GENERAL_TASKS/`
|
|
18
|
+
|
|
19
|
+
Extract from task file:
|
|
20
|
+
- Title
|
|
21
|
+
- Description
|
|
22
|
+
- Acceptance criteria
|
|
23
|
+
- Labels (sprint number, task type)
|
|
24
|
+
|
|
25
|
+
## 2 · Generate Issue Template
|
|
26
|
+
|
|
27
|
+
```markdown
|
|
28
|
+
## 📋 Task: {task_title}
|
|
29
|
+
|
|
30
|
+
### Description
|
|
31
|
+
{task_description}
|
|
32
|
+
|
|
33
|
+
### Acceptance Criteria
|
|
34
|
+
{acceptance_criteria}
|
|
35
|
+
|
|
36
|
+
### Related Information
|
|
37
|
+
- Task ID: {task_id}
|
|
38
|
+
- Sprint: {sprint_id}
|
|
39
|
+
- Task file: `.aiwf/.../{task_file}`
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## 3 · Create GitHub Issue
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
gh issue create \
|
|
46
|
+
--title "{task_id}: {task_title}" \
|
|
47
|
+
--body "{issue_body}" \
|
|
48
|
+
--label "task,{sprint_label}" \
|
|
49
|
+
--assignee "@me"
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Capture the created issue number
|
|
53
|
+
|
|
54
|
+
## 4 · Update Task File
|
|
55
|
+
|
|
56
|
+
Add to task file frontmatter:
|
|
57
|
+
```yaml
|
|
58
|
+
github_issue: #{issue_number}
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
## 5 · Report Results
|
|
62
|
+
|
|
63
|
+
✅ **Issue Created**: #{issue_number}
|
|
64
|
+
🔗 **Link**: {issue_url}
|
|
65
|
+
📄 **Task**: {task_id}
|
|
@@ -0,0 +1,272 @@
|
|
|
1
|
+
# Mermaid 다이어그램 유지 관리
|
|
2
|
+
|
|
3
|
+
Instructions for generating, maintaining and updating the mermaid diagrams in the current project's architecture documentation.
|
|
4
|
+
|
|
5
|
+
## 📋 Overview
|
|
6
|
+
|
|
7
|
+
The architecture documentation should include comprehensive mermaid diagrams that illustrate:
|
|
8
|
+
|
|
9
|
+
- System context and component relationships
|
|
10
|
+
- Module dependencies and data flows (150+ modules)
|
|
11
|
+
- Class hierarchies and interactions
|
|
12
|
+
- Service layer patterns and UI architecture
|
|
13
|
+
|
|
14
|
+
## 📂 Diagram Locations
|
|
15
|
+
|
|
16
|
+
All architecture diagrams are to be stored in `/docs/architecture/`:
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
docs/architecture/
|
|
20
|
+
├── README.md # Main architecture overview
|
|
21
|
+
├── context_diagram.md # System context & data flow
|
|
22
|
+
├── module_overview.md # Module relationships (150+ modules)
|
|
23
|
+
└── class_diagrams/
|
|
24
|
+
├── core_classes.md # Database, DAOs, data processing
|
|
25
|
+
├── data_models.md # Domain models & database schema
|
|
26
|
+
└── service_layer.md # UI architecture & service coordination
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## 🛠️ Update Process
|
|
30
|
+
|
|
31
|
+
### Step 1: Identify Affected Diagrams
|
|
32
|
+
|
|
33
|
+
Determine which diagrams need updates based on your changes:
|
|
34
|
+
|
|
35
|
+
| Change Type | Primary Diagram | Secondary Diagrams |
|
|
36
|
+
| ---------------------- | ------------------ | ------------------ |
|
|
37
|
+
| New analytics module | module_overview.md | context_diagram.md |
|
|
38
|
+
| Database schema change | data_models.md | core_classes.md |
|
|
39
|
+
| New UI component | service_layer.md | module_overview.md |
|
|
40
|
+
| New service/manager | service_layer.md | module_overview.md |
|
|
41
|
+
| Architecture refactor | context_diagram.md | All others |
|
|
42
|
+
|
|
43
|
+
### Step 2: Update Mermaid Code
|
|
44
|
+
|
|
45
|
+
Edit the relevant `.md` files to update mermaid diagram code:
|
|
46
|
+
|
|
47
|
+
```mermaid
|
|
48
|
+
# Example: Adding a new class to core_classes.md
|
|
49
|
+
class NewAnalyticsService {
|
|
50
|
+
-CacheManager cache_manager
|
|
51
|
+
-Logger logger
|
|
52
|
+
+calculate_advanced_metrics() Dict
|
|
53
|
+
+generate_insights() List[str]
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
# Add relationships
|
|
57
|
+
NewAnalyticsService --> CacheManager : uses
|
|
58
|
+
NewAnalyticsService --> DatabaseManager : queries
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Step 3: Validate Diagrams
|
|
62
|
+
|
|
63
|
+
Test diagram syntax and rendering:
|
|
64
|
+
|
|
65
|
+
1. **Online validation**: Copy mermaid code to [Mermaid Live Editor](https://mermaid.live/)
|
|
66
|
+
2. **Local preview**: Use VS Code Mermaid extensions
|
|
67
|
+
3. **Check syntax**: Ensure proper mermaid formatting
|
|
68
|
+
|
|
69
|
+
### Step 4: Update Cross-References
|
|
70
|
+
|
|
71
|
+
Update any cross-references in documentation:
|
|
72
|
+
|
|
73
|
+
- Update `docs/architecture/README.md` if adding new diagrams
|
|
74
|
+
- Update navigation links between diagram files
|
|
75
|
+
- Update main project README if architecture changes significantly
|
|
76
|
+
|
|
77
|
+
## 📝 Mermaid Syntax Guidelines
|
|
78
|
+
|
|
79
|
+
### Class Diagrams
|
|
80
|
+
|
|
81
|
+
```mermaid
|
|
82
|
+
classDiagram
|
|
83
|
+
class ClassName {
|
|
84
|
+
-private_field: Type
|
|
85
|
+
+public_method() ReturnType
|
|
86
|
+
#protected_method(param: Type) void
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
%% Relationships
|
|
90
|
+
ClassA <|-- ClassB : inherits
|
|
91
|
+
ClassA *-- ClassC : composition
|
|
92
|
+
ClassA --> ClassD : uses
|
|
93
|
+
ClassA ..> ClassE : depends on
|
|
94
|
+
|
|
95
|
+
%% Notes
|
|
96
|
+
note for ClassName "Important implementation details"
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### Flowcharts
|
|
100
|
+
|
|
101
|
+
```mermaid
|
|
102
|
+
flowchart TD
|
|
103
|
+
A[Start] --> B{Decision}
|
|
104
|
+
B -->|Yes| C[Action 1]
|
|
105
|
+
B -->|No| D[Action 2]
|
|
106
|
+
C --> E[End]
|
|
107
|
+
D --> E
|
|
108
|
+
|
|
109
|
+
%% Styling
|
|
110
|
+
style A fill:#e1f5fe
|
|
111
|
+
style E fill:#e8f5e8
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### Sequence Diagrams
|
|
115
|
+
|
|
116
|
+
```mermaid
|
|
117
|
+
sequenceDiagram
|
|
118
|
+
participant A as Actor
|
|
119
|
+
participant B as System
|
|
120
|
+
|
|
121
|
+
A->>B: Request
|
|
122
|
+
B->>B: Process
|
|
123
|
+
B-->>A: Response
|
|
124
|
+
|
|
125
|
+
Note over A,B: Important interaction
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
## 🎨 Styling Guidelines
|
|
129
|
+
|
|
130
|
+
### Color Scheme
|
|
131
|
+
|
|
132
|
+
Use consistent colors across all diagrams:
|
|
133
|
+
|
|
134
|
+
```mermaid
|
|
135
|
+
%% Standard color palette
|
|
136
|
+
style MainComponents fill:#4ecdc4,color:#fff
|
|
137
|
+
style DataLayer fill:#f3e5f5
|
|
138
|
+
style CacheLayer fill:#fff8e1
|
|
139
|
+
style UILayer fill:#e8f5e8
|
|
140
|
+
style ExternalSystems fill:#e1f5fe
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### Component Categories
|
|
144
|
+
|
|
145
|
+
- **🏗️ Core Infrastructure**: `#4ecdc4` (teal)
|
|
146
|
+
- **📊 Analytics/Data**: `#f3e5f5` (light purple)
|
|
147
|
+
- **⚡ Caching/Performance**: `#fff8e1` (light yellow)
|
|
148
|
+
- **🎨 UI Components**: `#e8f5e8` (light green)
|
|
149
|
+
- **🔗 External Systems**: `#e1f5fe` (light blue)
|
|
150
|
+
|
|
151
|
+
## 📋 Common Update Scenarios
|
|
152
|
+
|
|
153
|
+
### Adding a New Analytics Module
|
|
154
|
+
|
|
155
|
+
1. **Update module_overview.md**: Add to Analytics Engine section
|
|
156
|
+
2. **Update class diagrams**: Add detailed class structure if significant
|
|
157
|
+
3. **Update context_diagram.md**: Add if it's a major new capability
|
|
158
|
+
|
|
159
|
+
```mermaid
|
|
160
|
+
# Example: New trend analysis module
|
|
161
|
+
TREND_ANALYZER[trend_analyzer.py<br/>📈 Advanced Trends]
|
|
162
|
+
TREND_ANALYZER --> DAILY_CALC
|
|
163
|
+
TREND_ANALYZER --> CACHE
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
### New UI Component or Widget
|
|
167
|
+
|
|
168
|
+
1. **Update service_layer.md**: Add class definition and relationships
|
|
169
|
+
2. **Update module_overview.md**: Add to UI Layer section
|
|
170
|
+
3. **Consider component factory updates**
|
|
171
|
+
|
|
172
|
+
```mermaid
|
|
173
|
+
# Example: New dashboard widget
|
|
174
|
+
class NewDashboardWidget {
|
|
175
|
+
-MetricsCalculator calculator
|
|
176
|
+
-ComponentFactory factory
|
|
177
|
+
+setup_ui() void
|
|
178
|
+
+refresh_data() void
|
|
179
|
+
}
|
|
180
|
+
QWidget <|-- NewDashboardWidget : inherits
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
### Database Schema Changes
|
|
184
|
+
|
|
185
|
+
1. **Update data_models.md**: Modify ER diagram and class definitions
|
|
186
|
+
2. **Update core_classes.md**: Update DAO methods if needed
|
|
187
|
+
3. **Document migration requirements**
|
|
188
|
+
|
|
189
|
+
### New Service or Manager Class
|
|
190
|
+
|
|
191
|
+
1. **Update service_layer.md**: Add to appropriate service category
|
|
192
|
+
2. **Update relationships**: Show dependencies and usage patterns
|
|
193
|
+
3. **Update module_overview.md**: Add service layer connections
|
|
194
|
+
|
|
195
|
+
## 🔍 Validation Checklist
|
|
196
|
+
|
|
197
|
+
Before committing diagram updates:
|
|
198
|
+
|
|
199
|
+
- [ ] **Syntax Valid**: Diagram renders without errors
|
|
200
|
+
- [ ] **Consistent Styling**: Uses standard color scheme
|
|
201
|
+
- [ ] **Accurate Relationships**: Reflects actual code relationships
|
|
202
|
+
- [ ] **Clear Labels**: All components clearly labeled
|
|
203
|
+
- [ ] **Cross-References Updated**: Navigation links work
|
|
204
|
+
- [ ] **README Updated**: Main architecture README reflects changes
|
|
205
|
+
|
|
206
|
+
## 🤖 Automation & Maintenance Scripts
|
|
207
|
+
|
|
208
|
+
### Useful Commands for Analysis
|
|
209
|
+
|
|
210
|
+
```bash
|
|
211
|
+
# Find all Python classes in the codebase
|
|
212
|
+
find src/ -name "*.py" -exec grep -l "^class " {} \; | sort
|
|
213
|
+
|
|
214
|
+
# Check module imports to understand dependencies
|
|
215
|
+
grep -r "^from src\." src/ | cut -d: -f2 | sort | uniq
|
|
216
|
+
|
|
217
|
+
# Find new files since last commit
|
|
218
|
+
git diff --name-only HEAD~1 | grep "\.py$"
|
|
219
|
+
|
|
220
|
+
# Count modules by package
|
|
221
|
+
find src/ -name "*.py" | cut -d/ -f2 | sort | uniq -c
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
### Maintenance Tasks
|
|
225
|
+
|
|
226
|
+
1. **Quarterly Review**: Compare diagrams against actual codebase structure
|
|
227
|
+
2. **Release Preparation**: Ensure all diagrams reflect release state
|
|
228
|
+
3. **Refactoring Support**: Update diagrams during major refactors
|
|
229
|
+
4. **New Developer Onboarding**: Keep diagrams current for documentation
|
|
230
|
+
|
|
231
|
+
## 🚨 Best Practices
|
|
232
|
+
|
|
233
|
+
### Do's
|
|
234
|
+
|
|
235
|
+
- ✅ **Keep diagrams focused**: One primary concept per diagram
|
|
236
|
+
- ✅ **Use consistent naming**: Match actual class/module names
|
|
237
|
+
- ✅ **Add explanatory notes**: Include important design decisions
|
|
238
|
+
- ✅ **Regular updates**: Keep diagrams current with code changes
|
|
239
|
+
- ✅ **Validate syntax**: Always test before committing
|
|
240
|
+
|
|
241
|
+
### Don'ts
|
|
242
|
+
|
|
243
|
+
- ❌ **Avoid over-complexity**: Don't include every minor detail
|
|
244
|
+
- ❌ **Don't duplicate**: Each relationship should appear in most appropriate diagram
|
|
245
|
+
- ❌ **Avoid generic names**: Use specific, meaningful component names
|
|
246
|
+
- ❌ **Don't ignore styling**: Consistent colors improve readability
|
|
247
|
+
- ❌ **Don't skip validation**: Always check diagram rendering
|
|
248
|
+
|
|
249
|
+
## 📞 Support & Resources
|
|
250
|
+
|
|
251
|
+
### Documentation Resources
|
|
252
|
+
|
|
253
|
+
- [Mermaid Documentation](https://mermaid-js.github.io/mermaid/)
|
|
254
|
+
- [Mermaid Live Editor](https://mermaid.live/) - For testing diagrams
|
|
255
|
+
- [VS Code Mermaid Extension](https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid)
|
|
256
|
+
|
|
257
|
+
### Quick Reference
|
|
258
|
+
|
|
259
|
+
- **Architecture overview**: `/docs/architecture/README.md`
|
|
260
|
+
- **System context**: `/docs/architecture/context_diagram.md`
|
|
261
|
+
- **Module relationships**: `/docs/architecture/module_overview.md`
|
|
262
|
+
- **Class details**: `/docs/architecture/class_diagrams/`
|
|
263
|
+
|
|
264
|
+
### Getting Help
|
|
265
|
+
|
|
266
|
+
1. **Reference existing patterns**: Look at similar components in current diagrams
|
|
267
|
+
2. **Check diagram history**: Use git to see how similar changes were handled
|
|
268
|
+
3. **Ask in code review**: Get feedback on architectural accuracy
|
|
269
|
+
|
|
270
|
+
---
|
|
271
|
+
|
|
272
|
+
_Keep architecture diagrams accurate, useful, and maintainable as the project evolves. Focus on clarity and consistency to support both current development and future maintenance._
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# Create Pull Request After Task Completion
|
|
2
|
+
|
|
3
|
+
Create a GitHub Pull Request after task completion and link it with related issues.
|
|
4
|
+
|
|
5
|
+
## Create TODO with EXACTLY these 6 items
|
|
6
|
+
|
|
7
|
+
1. Check current branch and changes
|
|
8
|
+
2. Generate PR body template
|
|
9
|
+
3. Create GitHub PR
|
|
10
|
+
4. Link issue with PR
|
|
11
|
+
5. Assign reviewers
|
|
12
|
+
6. Report results
|
|
13
|
+
|
|
14
|
+
## 1 · Check Branch and Changes
|
|
15
|
+
|
|
16
|
+
Run in parallel:
|
|
17
|
+
- `git branch --show-current`: Check current branch
|
|
18
|
+
- `git log main..HEAD --oneline`: Commit history
|
|
19
|
+
- `git diff main...HEAD --stat`: Changed files statistics
|
|
20
|
+
|
|
21
|
+
Extract GitHub issue number from task file
|
|
22
|
+
|
|
23
|
+
## 2 · Generate PR Body Template
|
|
24
|
+
|
|
25
|
+
```markdown
|
|
26
|
+
## 🎯 Overview
|
|
27
|
+
Completed implementation of {task_title}.
|
|
28
|
+
|
|
29
|
+
## 📝 Changes
|
|
30
|
+
{commit_list}
|
|
31
|
+
|
|
32
|
+
## 📊 Changed Files
|
|
33
|
+
{file_statistics}
|
|
34
|
+
|
|
35
|
+
## ✅ Checklist
|
|
36
|
+
- [ ] Tests pass
|
|
37
|
+
- [ ] Code review completed
|
|
38
|
+
- [ ] Documentation updated
|
|
39
|
+
|
|
40
|
+
## 🔗 Related Information
|
|
41
|
+
- Closes #{issue_number}
|
|
42
|
+
- Task: {task_id}
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## 3 · Create GitHub PR
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
gh pr create \
|
|
49
|
+
--title "{task_id}: {task_title}" \
|
|
50
|
+
--body "$(cat <<'EOF'
|
|
51
|
+
{pr_body}
|
|
52
|
+
EOF
|
|
53
|
+
)" \
|
|
54
|
+
--base main \
|
|
55
|
+
--head {branch_name}
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## 4 · Link Issue with PR
|
|
59
|
+
|
|
60
|
+
Automatically included in PR body:
|
|
61
|
+
- `Closes #{issue_number}`: Auto-close issue
|
|
62
|
+
- `Relates to #{issue_number}`: Show relationship
|
|
63
|
+
|
|
64
|
+
## 5 · Assign Reviewers
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
gh pr edit {pr_number} \
|
|
68
|
+
--add-reviewer {reviewer_username}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## 6 · Report Results
|
|
72
|
+
|
|
73
|
+
✅ **PR Created**: #{pr_number}
|
|
74
|
+
🔗 **Link**: {pr_url}
|
|
75
|
+
🎯 **Linked Issue**: #{issue_number}
|
|
76
|
+
👥 **Reviewers**: {reviewers}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# 지식 프라임
|
|
2
|
+
|
|
3
|
+
Prime yourself with basic information about this project.
|
|
4
|
+
Make sure you are aware of the environment.
|
|
5
|
+
|
|
6
|
+
## USE **PARALLEL AGENTS** to
|
|
7
|
+
|
|
8
|
+
- READ .aiwf/01_PROJECT_DOCS/ARCHITECTURE.md for basic Project Information
|
|
9
|
+
- READ .aiwf/00_PROJECT_MANIFEST.md for the Project status
|