aiwf 0.1.0 → 0.3.1
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 +46 -0
- package/CLAUDE.md +19 -0
- package/LICENSE +1 -1
- package/README.ko.md +90 -62
- package/README.md +109 -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_docs.md +225 -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_language_manager.md +287 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_language_status.md +246 -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_project_review.md +261 -0
- package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_switch_language.md +160 -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_docs.md +225 -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_language_manager.md +287 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_language_status.md +246 -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_project_review.md +261 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_switch_language.md +160 -0
- package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_test.md +124 -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 +305 -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} +38 -24
- package/docs/AI-WORKFLOW.md +299 -0
- package/docs/COMMANDS_GUIDE.ko.md +727 -0
- package/docs/COMMANDS_GUIDE.md +726 -0
- package/docs/CONTRIBUTING.md +406 -0
- package/docs/DEVELOPMENT_GUIDE.md +727 -0
- package/docs/Enhanced_Installation_Flow_Design.md +498 -0
- package/docs/PRD.ko.md +148 -0
- package/docs/PRD.md +150 -0
- package/docs/moonklabs-metadata-system-prd.md +127 -0
- package/index.js +1493 -122
- package/jest.config.js +4 -0
- package/language-cli.js +279 -0
- package/language-utils.js +330 -0
- package/package.json +23 -10
- package/scripts/validate-commands.cjs +338 -0
- package/scripts/validate-commands.js +254 -0
- package/tests/basic.test.js +62 -0
- package/tests/commands.test.js +127 -0
- package/tests/installer.test.js +129 -0
- package/tests/language-utils.test.js +271 -0
- package/COMMANDS_GUIDE.md +0 -462
- package/PRD.ko.md +0 -96
- package/PRD.md +0 -98
- 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,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
|
+
# Prime Knowledge
|
|
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
|
|
@@ -0,0 +1,261 @@
|
|
|
1
|
+
# Project Review - Top-Down Execution
|
|
2
|
+
|
|
3
|
+
Perform a comprehensive project-level review focusing on architecture, progress, and technical decisions.
|
|
4
|
+
|
|
5
|
+
**IMPORTANT:**
|
|
6
|
+
|
|
7
|
+
- This is a high-level review of overall project state, not recent changes.
|
|
8
|
+
- Unless clearly mentioned in project documents, there is no timeline and schedule is irrelevant
|
|
9
|
+
|
|
10
|
+
## Create a TODO with EXACTLY these 9 Items
|
|
11
|
+
|
|
12
|
+
1. Analyze review scope and timing
|
|
13
|
+
2. Execute and assess test infrastructure health
|
|
14
|
+
3. Assess project documentation alignment
|
|
15
|
+
4. Review milestone and sprint progress
|
|
16
|
+
5. Analyze codebase architecture and structure
|
|
17
|
+
6. Audit file organization and workflow compliance
|
|
18
|
+
7. Evaluate technical decisions and complexity
|
|
19
|
+
8. Critique implementation quality (John Carmack perspective)
|
|
20
|
+
9. Provide comprehensive assessment with recommendations
|
|
21
|
+
|
|
22
|
+
Follow step by step and adhere closely to the following instructions for each step.
|
|
23
|
+
|
|
24
|
+
## DETAILS on every TODO item
|
|
25
|
+
|
|
26
|
+
### 1. Analyze review scope and timing
|
|
27
|
+
|
|
28
|
+
Check: <$ARGUMENTS>
|
|
29
|
+
|
|
30
|
+
If empty, perform full project review. Otherwise interpret <$ARGUMENTS> to identify specific focus areas (milestone, sprint, architecture component, etc.). Unless stated in Argument do not compare to previews project reviews in `.aiwf/10_STATE_OF_PROJECT`.
|
|
31
|
+
|
|
32
|
+
**IMPORTANT:** This review looks at overall project state in context of recent changes.
|
|
33
|
+
|
|
34
|
+
**CRITICAL:** Read `.aiwf/00_PROJECT_MANIFEST.md` FIRST to understand:
|
|
35
|
+
|
|
36
|
+
- Current milestone and sprint status
|
|
37
|
+
- What work is complete vs in-progress vs planned
|
|
38
|
+
- Active sprint objectives and deliverables
|
|
39
|
+
|
|
40
|
+
**CONTEXT CHECK:** Before evaluating functionality:
|
|
41
|
+
|
|
42
|
+
- Navigate to `.aiwf/03_SPRINTS/` to find the current sprint
|
|
43
|
+
- Read the sprint meta file to understand what's in scope
|
|
44
|
+
- Check completed vs planned tasks within the sprint
|
|
45
|
+
- Understand what future sprints will deliver
|
|
46
|
+
|
|
47
|
+
**REVIEW PRINCIPLE:** Evaluate against CURRENT SPRINT deliverables, not full milestone scope.
|
|
48
|
+
|
|
49
|
+
### 2. Execute and assess test infrastructure health
|
|
50
|
+
|
|
51
|
+
**CRITICAL:** Test infrastructure health is a BLOCKING criteria for sprint/milestone progression.
|
|
52
|
+
|
|
53
|
+
- USE test.md command to execute full test suite (@.claude/commands/aiwf/aiwf_test.md)
|
|
54
|
+
- ANALYZE test results: passed/failed/skipped counts and failure categories
|
|
55
|
+
- CALCULATE test health score (0-10 scale):
|
|
56
|
+
- 10: 100% pass rate, no infrastructure issues
|
|
57
|
+
- 8-9: >95% pass rate, minor issues only
|
|
58
|
+
- 6-7: 80-95% pass rate, some non-critical failures
|
|
59
|
+
- 4-5: 60-80% pass rate, significant issues
|
|
60
|
+
- 0-3: <60% pass rate, critical infrastructure problems
|
|
61
|
+
- CATEGORIZE failures:
|
|
62
|
+
- Infrastructure: Import errors, missing modules
|
|
63
|
+
- Configuration: Environment variables, database connections
|
|
64
|
+
- Logic: Assertion failures, actual bugs
|
|
65
|
+
- Flaky: Intermittent failures
|
|
66
|
+
- DETERMINE blocking status:
|
|
67
|
+
- Score < 6: BLOCKS sprint progression
|
|
68
|
+
- Score < 8: BLOCKS milestone completion
|
|
69
|
+
- Score < 4: TRIGGERS emergency escalation
|
|
70
|
+
- IDENTIFY root causes of any infrastructure failures
|
|
71
|
+
- TRACK trend vs previous review (improvement/degradation)
|
|
72
|
+
- ASSESS test strategy validity for scope of the project. Tests should be pragmatic and help assuring functionality but not get in the way of development progress too much.
|
|
73
|
+
|
|
74
|
+
### 3. Assess project documentation alignment
|
|
75
|
+
|
|
76
|
+
**USE PARALLEL AGENTS** to follow these steps:
|
|
77
|
+
|
|
78
|
+
- READ all core documents in `.aiwf/01_PROJECT_DOCS/` especially ARCHITECTURE.md
|
|
79
|
+
- READ current milestone requirements in `.aiwf/02_REQUIREMENTS/`
|
|
80
|
+
- READ architecture decisions in `.aiwf/05_ARCHITECTURE_DECISIONS` as they might extend/contradict other documents
|
|
81
|
+
- IDENTIFY any gaps between documentation and current implementation
|
|
82
|
+
- CHECK if the project is still following the documented architecture vision
|
|
83
|
+
- VERIFY that current code structure matches documented patterns
|
|
84
|
+
|
|
85
|
+
**IMPORTANT:** Documentation is our source of truth. Any deviation needs justification.
|
|
86
|
+
|
|
87
|
+
### 4. Review milestone and sprint progress
|
|
88
|
+
|
|
89
|
+
**USE PARALLEL AGENTS** to follow these steps:
|
|
90
|
+
|
|
91
|
+
- READ `.aiwf/00_PROJECT_MANIFEST.md` for current status
|
|
92
|
+
- ANALYZE completed sprints in `.aiwf/03_SPRINTS/`
|
|
93
|
+
- COMPARE actual progress against CURRENT SPRINT deliverables (not full milestone)
|
|
94
|
+
- DISTINGUISH between sprint-level tasks vs milestone-level features
|
|
95
|
+
- ASSESS if current sprint focus aligns with milestone goals
|
|
96
|
+
|
|
97
|
+
### 5. Analyze codebase architecture and structure
|
|
98
|
+
|
|
99
|
+
#
|
|
100
|
+
|
|
101
|
+
**USE PARALLEL AGENTS** to follow these steps:
|
|
102
|
+
|
|
103
|
+
- EXAMINE overall project structure and organization
|
|
104
|
+
- ANALYZE import patterns and dependency relationships
|
|
105
|
+
- REVIEW database models and API structure for consistency
|
|
106
|
+
- CHECK for architectural patterns: are we following DDD, clean architecture, etc.?
|
|
107
|
+
- IDENTIFY any architectural debt or inconsistencies
|
|
108
|
+
|
|
109
|
+
**Focus areas:**
|
|
110
|
+
|
|
111
|
+
- **Directory structure** — logical organization, separation of concerns
|
|
112
|
+
- **Dependencies** — are we over-engineering? unnecessary libraries?
|
|
113
|
+
- **Models/Schemas** — consistency, proper relationships, normalization
|
|
114
|
+
- **APIs** — RESTful design, proper HTTP methods, consistent patterns
|
|
115
|
+
- **Configuration** — environment management, secrets handling
|
|
116
|
+
|
|
117
|
+
### 6. Audit file organization and workflow compliance
|
|
118
|
+
|
|
119
|
+
**IMPORTANT:** Check for workflow discipline and architectural boundary violations.
|
|
120
|
+
|
|
121
|
+
- **Root directory audit** — identify files that don't belong in project root
|
|
122
|
+
- **Development scripts** — verify all dev scripts follow `run_dev.py` pattern
|
|
123
|
+
- **Test file organization** — check tests are in `tests/` directory, not scattered
|
|
124
|
+
- **Documentation placement** — verify docs are in proper locations
|
|
125
|
+
- **Temporary/experimental files** — flag any `.py` files that look ad-hoc or experimental
|
|
126
|
+
|
|
127
|
+
**File Organization Rules to Enforce:**
|
|
128
|
+
|
|
129
|
+
- **Development scripts** — MUST go through `run_dev.py`, not standalone files
|
|
130
|
+
- **Test files** — MUST be in `tests/` directory with proper naming (`test_*.py`)
|
|
131
|
+
- **Documentation** — MUST be in `docs/` or `.aiwf/01_PROJECT_DOCS/`
|
|
132
|
+
- **Configuration** — MUST follow established patterns (`.env.example`, `pyproject.toml`)
|
|
133
|
+
- **Temporary files** — SHOULD NOT exist in committed code
|
|
134
|
+
|
|
135
|
+
**Red Flags to Identify:**
|
|
136
|
+
|
|
137
|
+
- Multiple scripts doing similar things (duplicate functionality)
|
|
138
|
+
- Random `.py` files in root directory
|
|
139
|
+
- Test files outside `tests/` directory
|
|
140
|
+
- Development scripts bypassing `run_dev.py`
|
|
141
|
+
- Unclear file purposes or experimental code
|
|
142
|
+
|
|
143
|
+
**CRITICAL:** File proliferation indicates workflow breakdown. Flag for immediate cleanup task creation.
|
|
144
|
+
|
|
145
|
+
### 7. Evaluate technical decisions and complexity
|
|
146
|
+
|
|
147
|
+
- ASSESS complexity vs. business value ratio
|
|
148
|
+
- REVIEW choice of frameworks, libraries, and tools
|
|
149
|
+
- ANALYZE if current patterns will scale with project growth
|
|
150
|
+
- IDENTIFY areas where we might be over-complicating simple problems
|
|
151
|
+
- CHECK for premature optimization or under-optimization
|
|
152
|
+
|
|
153
|
+
**IMPORTANT:** Think like an experienced developer. Are we solving the right problems the right way?
|
|
154
|
+
|
|
155
|
+
### 8. Critique implementation quality (John Carmack perspective)
|
|
156
|
+
|
|
157
|
+
Think as John Carmack would: focus on simplicity, performance, and maintainability, but keep the projects goal in mind. Especially long term vision as well. Don't over simplify.
|
|
158
|
+
|
|
159
|
+
- **Simplicity:** Are we solving problems in the most straightforward way?
|
|
160
|
+
- **Performance:** Are there obvious performance issues or bottlenecks?
|
|
161
|
+
- **Maintainability:** Will a new developer understand this code in 6 months?
|
|
162
|
+
- **Robustness:** How does the system handle edge cases and failures?
|
|
163
|
+
- **Technical debt:** What shortcuts are we taking that will hurt us later?
|
|
164
|
+
|
|
165
|
+
Be **brutally honest**. Carmack-level critique means no sugar-coating but still staying true to the project's reality.
|
|
166
|
+
Be thorough and **go above and beyond** in your analysis - leave no stone unturned.
|
|
167
|
+
|
|
168
|
+
### 9. Provide comprehensive assessment with recommendations
|
|
169
|
+
|
|
170
|
+
**IMPORTANT:** Get current timestamp and create output file
|
|
171
|
+
|
|
172
|
+
- Get current timestamp using system date command
|
|
173
|
+
- Create filename: `YYYY-MM-DD-HH-MM-<judgment-slug>.md` in `.aiwf/10_STATE_OF_PROJECT/`
|
|
174
|
+
- Judgment slug should be 2-3 words describing overall project health (e.g., "solid-progress", "needs-focus", "critical-issues", "doing-great", "on-track")
|
|
175
|
+
|
|
176
|
+
**IMPORTANT:** Write full report to the timestamped file with this format:
|
|
177
|
+
|
|
178
|
+
```markdown
|
|
179
|
+
# Project Review - [YYYY-MM-DD HH:MM]
|
|
180
|
+
|
|
181
|
+
## 🎭 Review Sentiment
|
|
182
|
+
|
|
183
|
+
[3 emojis only - no explanations]
|
|
184
|
+
|
|
185
|
+
## Executive Summary
|
|
186
|
+
|
|
187
|
+
- **Result:** EXCELLENT | GOOD | NEEDS_WORK | CRITICAL_ISSUES
|
|
188
|
+
- **Scope:** What areas were reviewed
|
|
189
|
+
- **Overall Judgment:** [2-3 word assessment used in filename]
|
|
190
|
+
|
|
191
|
+
## Test Infrastructure Assessment
|
|
192
|
+
|
|
193
|
+
- **Test Suite Status**: [PASSING/FAILING/BLOCKED] (X/Y tests)
|
|
194
|
+
- **Test Pass Rate**: X% (Y passed, Z failed)
|
|
195
|
+
- **Test Health Score**: X/10
|
|
196
|
+
- **Infrastructure Health**: [HEALTHY/DEGRADED/BROKEN]
|
|
197
|
+
- Import errors: [count]
|
|
198
|
+
- Configuration errors: [count]
|
|
199
|
+
- Fixture issues: [count]
|
|
200
|
+
- **Test Categories**:
|
|
201
|
+
- Unit Tests: X/Y passing
|
|
202
|
+
- Integration Tests: X/Y passing
|
|
203
|
+
- API Tests: X/Y passing
|
|
204
|
+
- **Critical Issues**:
|
|
205
|
+
- [List of blocking test infrastructure problems]
|
|
206
|
+
- [Module import mismatches]
|
|
207
|
+
- [Environment configuration failures]
|
|
208
|
+
- **Sprint Coverage**: [% of sprint deliverables with passing tests]
|
|
209
|
+
- **Blocking Status**: [CLEAR/BLOCKED - reason]
|
|
210
|
+
- **Recommendations**:
|
|
211
|
+
- [Immediate fixes required]
|
|
212
|
+
- [Test infrastructure improvements needed]
|
|
213
|
+
|
|
214
|
+
## Development Context
|
|
215
|
+
|
|
216
|
+
- **Current Milestone:** [ID and status from manifest]
|
|
217
|
+
- **Current Sprint:** [ID and focus]
|
|
218
|
+
- **Expected Completeness:** [what SHOULD be done at this stage]
|
|
219
|
+
|
|
220
|
+
## Progress Assessment
|
|
221
|
+
|
|
222
|
+
- **Milestone Progress:** [percentage complete]
|
|
223
|
+
- **Sprint Status:** [current sprint assessment]
|
|
224
|
+
- **Deliverable Tracking:** [what's done vs planned]
|
|
225
|
+
|
|
226
|
+
## Architecture & Technical Assessment
|
|
227
|
+
|
|
228
|
+
- **Architecture Score:** 1-10 rating with explanation
|
|
229
|
+
- **Technical Debt Level:** LOW | MEDIUM | HIGH with specific examples
|
|
230
|
+
- **Code Quality:** [overall assessment with examples]
|
|
231
|
+
|
|
232
|
+
## File Organization Audit
|
|
233
|
+
|
|
234
|
+
- **Workflow Compliance:** GOOD | NEEDS_ATTENTION | CRITICAL_VIOLATIONS
|
|
235
|
+
- **File Organization Issues:** [list any misplaced files, duplicate scripts, etc.]
|
|
236
|
+
- **Cleanup Tasks Needed:** [specific file moves/deletions/consolidations required]
|
|
237
|
+
|
|
238
|
+
## Critical Findings
|
|
239
|
+
|
|
240
|
+
### Critical Issues (Severity 8-10)
|
|
241
|
+
|
|
242
|
+
[Lists of must-fix problems headed with #### heading, one empty line and then list of details]
|
|
243
|
+
|
|
244
|
+
### Improvement Opportunities (Severity 4-7)
|
|
245
|
+
|
|
246
|
+
[List of recommended enhancements headed with #### heading, one empty line and then list of details]
|
|
247
|
+
|
|
248
|
+
## John Carmack Critique 🔥
|
|
249
|
+
|
|
250
|
+
[Top 3 brutally honest observations about technical decisions]
|
|
251
|
+
|
|
252
|
+
## Recommendations
|
|
253
|
+
|
|
254
|
+
Based on your findings recommend Action items - chose whatever fits your findings
|
|
255
|
+
|
|
256
|
+
- **Important fixes:** What needs to be fixed immediately?
|
|
257
|
+
- **Optional fixes/changes:** What would still be recommended though optional?
|
|
258
|
+
- **Next Sprint Focus:** Can the user move to the next sprint?
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
**IMPORTANT:** Be specific with file paths and line numbers. This review should be actionable and permanently archived.
|