Files
xtremobile/.instructions.md
T
GitHub Copilot c5fcafcce1 Phase 2: Performance Profiling Setup - Add profiling utilities
- Add StartupProfiler: Measure cold/warm start times
- Add VideoProfiler: Profile video load, playback metrics
- Add MemoryProfiler: Detect memory leaks, monitor heap growth
- Add HiveEncryptionBenchmark: Measure encryption overhead
- Add PHASE_2_PROFILING_PLAN.md: Complete testing procedures

Ready for profiling execution once Flutter SDK is initialized
2026-03-25 21:56:08 +01:00

308 lines
8.7 KiB
Markdown

# 🚀 XtremFlow BMAD Master Configuration
## VS Code Copilot Agent Instructions
This project uses the **BMad Method Framework** with the **BMAD Master Agent** to guide development with specialized AI agents. The Master Agent orchestrates PM, Architect, Developer, QA, Security Expert, and other specialists through proven workflows.
---
## 🎯 BMAD Master Agent (Active)
### ⚡ Quick Invocation
```
@bmad-master [your request]
```
### Example Commands
```
@bmad-master I'm ready to start Phase 1. How do we begin?
@bmad-master Show me the implementation plan for this week
@bmad-master I'm stuck on JWT, help me out
@bmad-master What should I do next?
```
**Result**: Orchestrated guidance with all necessary agents coordinated
---
## 📋 Quick Start with BMAD Master
### Invoke BMad Help Anytime
```
bmad-help
```
Ask questions like:
- "What's next after the architecture phase?"
- "I need to set up logging, what's the best approach?"
- "How do I handle database migrations?"
---
## 🎯 XtremFlow Development Roadmap (Using BMad Agents)
### Phase 1: Infrastructure & Security (Week 1)
Use these **BMad Agents** in sequence:
#### 1️⃣ **PM Agent** - Define Requirements
```
Stakeholder: I need to improve logging, error handling, and authentication
Task: Use BMAD PM to create user stories and prioritize backlog
```
#### 2️⃣ **Architect Agent** - Design Solution
```
Context: Implementing Logging Service + JWT Auth
Task: Use BMAD Architect to design the system architecture
Reference: IMPROVEMENT_PLAN.md → Section 1
```
#### 3️⃣ **Developer Agent** - Implement
```
Task: Implement Logging Service (LoggingService class)
Reference: IMPLEMENTATION_GUIDE.md → Section 1
Use Developer agent to write production-grade code
```
#### 4️⃣ **QA Agent** - Test
```
Task: Create unit tests for LoggingService
Use QA agent to design comprehensive test coverage
```
---
## 🔧 XtremFlow Specific Workflows
### Workflow 1: Implement Logging System (Day 1)
**File**: `_bmad/bmm/1-analysis/` → Create `logging-system-analysis.md`
Steps:
1. **Analyze** current logging (print statements)
2. **Plan** logger package integration
3. **Solution** LoggingService architecture
4. **Implement** with code generation
Start with: `bmad-help I need to implement professional logging`
---
### Workflow 2: Security Hardening (Day 2-4)
**File**: `_bmad/bmm/1-analysis/` → Create `security-hardening.md`
1. **Analyze** current auth (password hashing, tokens)
2. **Plan** JWT + bcrypt implementation
3. **Solution** auth flow redesign
4. **Implement** AuthHandler updates
Start with: `bmad-help How do I secure password hashing and implement JWT?`
---
### Workflow 3: Database Reliability (Day 4-5)
**File**: `_bmad/bmm/1-analysis/` → Create `database-reliability.md`
1. **Analyze** database schema
2. **Plan** migrations system
3. **Solution** backup & recovery strategy
4. **Implement** migration runner
Start with: `bmad-help I need database migrations and automatic backups`
---
## 📍 Accessing BMad Agents
### In VS Code Claude Code/Copilot:
**Option 1: Direct Agent Invocation**
```
@pm I need help defining requirements for logging system
@architect Design me a logging architecture for Dart backend
@developer Write the LoggingService implementation
@qa Create unit tests for logging
```
**Option 2: Use BMad Skills**
- `#bmad-help` - Get contextual help
- `#bmad-analysis` - Deep dive analysis
- `#bmad-plan` - Create implementation plans
- `#bmad-code-review` - Review code quality
**Option 3: Workflow Mode**
Ask Claude to invoke the full BMad workflow:
```
"Let's use the BMad method to improve logging.
Start with analysis phase, then planning, then design, then implementation"
```
---
## 📂 BMad Output Structure
All BMad artifacts are stored in:
```
_bmad-output/
├── planning-artifacts/
│ ├── logging-system-plan.md
│ ├── security-hardening-plan.md
│ └── database-reliability-plan.md
├── implementation-artifacts/
│ ├── {component}-implementation.md
│ └── {component}-testing-strategy.md
└── docs/ # Project knowledge repo
├── IMPROVEMENT_PLAN.md # ✅ Already created
├── IMPLEMENTATION_GUIDE.md # ✅ Already created
└── PROBLEMS_AND_SOLUTIONS.md # ✅ Already created
```
---
## 🎯 Recommended Agent Workflows by Task
| Task | Primary Agent | Secondary | Output |
|------|---------------|-----------|--------|
| Analyze problema areas | **Analyst** | PM | Analysis report |
| Create implementation plan | **PM** | Architect | User stories, roadmap |
| Design architecture | **Architect** | Tech Lead | Architecture diagrams |
| Write code | **Developer** | QA | Production code |
| Create tests | **QA** | Developer | Test coverage report |
| Code review | **Code Reviewer** | Developer | Review feedback |
| Documentation | **Tech Writer** | Developer | API docs, guides |
---
## 💡 Example: Implement Logging (Using BMad)
### Step 1: Analysis Phase
```
@analyst Analyze current logging in XtremFlow backend
```
→ Creates: `_bmad-output/planning-artifacts/logging-analysis.md`
### Step 2: Planning Phase
```
@pm Create a detailed plan for implementing logger package in XtremFlow
Reference: IMPLEMENTATION_GUIDE.md Section 1
```
→ Creates: `_bmad-output/planning-artifacts/logging-plan.md`
### Step 3: Architecture Phase
```
@architect Design the LoggingService architecture for Dart backend
Include: File handler, console handler, request ID tracing
```
→ Creates: `_bmad-output/implementation-artifacts/logging-architecture.md`
### Step 4: Implementation Phase
```
@developer Implement LoggingService based on:
- Plan: _bmad-output/planning-artifacts/logging-plan.md
- Architecture: _bmad-output/implementation-artifacts/logging-architecture.md
- Reference: IMPLEMENTATION_GUIDE.md Section 1.2
Generate production-ready code with full documentation
```
→ Creates: Code files + `logging-service.dart`
### Step 5: Testing Phase
```
@qa Create comprehensive tests for LoggingService
Include: File writing, log levels, rotation, error handling
```
→ Creates: `test/unit/logging_service_test.dart`
---
## 🔄 BMad Method Phases Explained
### 1️⃣ **Analysis** (`_bmad/bmm/1-analysis/`)
- Understand current state
- Identify problems
- Gather requirements
- **Output**: Analysis documents
### 2️⃣ **Planning** (`_bmad/bmm/1-analysis/`)
- Define user stories
- Create roadmap
- Estimate effort
- **Output**: Planning artifacts
### 3️⃣ **Solutioning** (`_bmad/bmm/3-solutioning/`)
- Design architecture
- Evaluate options
- Create technical specs
- **Output**: Solution designs
### 4️⃣ **Implementation** (`_bmad/bmm/4-implementation/`)
- Write code
- Create tests
- Document features
- **Output**: Code + tests
---
## 🛠️ Integration with XtremFlow
### Current Status
- ✅ IMPROVEMENT_PLAN.md created
- ✅ IMPLEMENTATION_GUIDE.md created
- ✅ PROBLEMS_AND_SOLUTIONS.md created
- ✅ BMAD Framework installed
### Next Steps Using BMad
1. Invoke `@pm` to create user stories from IMPROVEMENT_PLAN.md
2. Invoke `@architect` to review and enhance architecture designs
3. Invoke `@developer` to implement each task
4. Invoke `@qa` to create test strategies
5. Use `bmad-help` for contextual guidance at each step
---
## 📚 Useful References
**BMad Documentation**: https://docs.bmad-method.org/
**BMad Discord**: https://discord.gg/gk8jAdXWmj
**This Project's Plans**:
- `IMPROVEMENT_PLAN.md` - Complete 5-level improvement roadmap
- `IMPLEMENTATION_GUIDE.md` - Code-level implementation details
- `PROBLEMS_AND_SOLUTIONS.md` - 26 identified issues with solutions
---
## 🎓 Tips for Working with BMad Agents
✅ **Be Specific**: Provide context, reference files, and requirements
✅ **Sequential Phases**: Follow analysis → planning → solutioning → implementation
✅ **Use References**: Point agents to IMPROVEMENT_PLAN.md and other docs
✅ **Request Artifacts**: Ask agents to create documents in `_bmad-output/`
✅ **Iterative**: Use `bmad-help` between steps to validate progress
✅ **Party Mode**: Bring multiple agents into one session for collaboration
---
## 🚀 Getting Started Right Now
**Option A: Quick Start**
```
In VS Code, invoke Copilot and type:
"bmad-help I want to improve XtremFlow backend"
```
**Option B: Structured Workflow**
```
1. @pm: "Create implementation plan from IMPROVEMENT_PLAN.md"
2. @architect: "Design Phase 1 infrastructure improvements"
3. @developer: "Implement logging system (Section 1.1)"
4. @qa: "Create tests for logging service"
```
**Option C: Guided Learning**
```
"Let me follow the full BMad Method workflow for improving XtremFlow.
Start by asking me clarifying questions about priorities."
```
---
*BMad Framework v6.2.1 installed*
*XtremFlow configuration created: 2026-03-25*