ai-flow-dev 2.4.5 → 2.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,277 @@
1
+ # Task Summary Template - Universal Format
2
+
3
+ **Purpose**: Generate standardized task summaries compatible with ClickUp, Jira, Linear, Asana, Trello, GitHub Projects, Azure DevOps, and any ticket management system.
4
+
5
+ **Usage**: This template is automatically populated by `/flow-work` after archiving completed work.
6
+
7
+ ---
8
+
9
+ ## 📋 Resumen de Tarea Completada
10
+
11
+ > **Compatibilidad**: ClickUp, Jira, Linear, Asana, Trello, GitHub Projects, Azure DevOps
12
+ > **Formato**: Markdown (copiar/pegar directo)
13
+
14
+ ---
15
+
16
+ ### 📌 Título
17
+
18
+ **[Type]: [Descriptive Feature Name]**
19
+
20
+ **Ejemplos:**
21
+
22
+ - `Feature: Bulk Mark as Read con PENDING→READ y subscriber_id opcional`
23
+ - `Refactor: Aplicar SRP a bulkMarkAsRead (110→50 líneas)`
24
+ - `Fix: Corregir race condition en notificaciones móviles`
25
+
26
+ ---
27
+
28
+ ### 📝 Descripción
29
+
30
+ [Párrafo 1: Contexto y problema - 2-3 líneas]
31
+ [Párrafo 2: Solución implementada - 2-3 líneas]
32
+
33
+ **Implementado:**
34
+
35
+ - [Feature/Fix 1 con detalles técnicos]
36
+ - [Feature/Fix 2 con detalles técnicos]
37
+ - [Feature/Fix 3 con detalles técnicos]
38
+
39
+ **Validación:**
40
+
41
+ - ✅ Tests: [X/X] passing ([Y] nuevos, [Z]% coverage)
42
+ - ✅ Lint: [N] errors, [M] warnings
43
+ - ✅ TypeCheck: passed/failed
44
+ - ✅ Docs: [N] archivos actualizados
45
+
46
+ ---
47
+
48
+ ### 📊 Métricas
49
+
50
+ | Campo | Valor |
51
+ | -------------------- | -------------------------------------- |
52
+ | **Duración** | [X]h [Y]min |
53
+ | **Esfuerzo** | [X.X] Story Points |
54
+ | **Commits** | [N] commits |
55
+ | **Branch** | `[feature/branch-name]` |
56
+ | **Archivos** | [N] modificados (+[XXX]/-[YYY] líneas) |
57
+ | **Breaking Changes** | ✅ No / ⚠️ Sí ([descripción]) |
58
+
59
+ ---
60
+
61
+ ### 🏷️ Labels/Tags
62
+
63
+ **Copiar según plataforma:**
64
+
65
+ - **ClickUp**: `Backend`, `API`, `[Scope]`, `Enhancement`
66
+ - **Jira**: Separar por comas en campo Labels
67
+ - **Linear**: Asignar a Team + Project correspondiente
68
+ - **GitHub**: Usar labels existentes del repo
69
+
70
+ **Tags generados:**
71
+
72
+ - **Tipo**: [Backend/Frontend/API/Database/Infrastructure]
73
+ - **Scope**: [módulo principal - ej: Deliveries, Auth, Subscribers]
74
+ - **Categoría**: [Enhancement/Bug Fix/Refactoring/Documentation/Security/Performance]
75
+ - **Prioridad**: [Critical/High/Medium/Low]
76
+
77
+ ---
78
+
79
+ ### 💡 Impacto
80
+
81
+ | Área | Impacto | Detalles |
82
+ | ------------------- | ---------------------------------------- | ------------------------------ |
83
+ | **UX** | [↑ Mejora / → Sin cambios / ↓ Regresión] | [descripción breve] |
84
+ | **Security** | [↑ Mejora / → Sin cambios / ⚠️ Atención] | [descripción breve] |
85
+ | **Performance** | [↑ Mejora / → Sin cambios / ↓ Regresión] | [descripción breve] |
86
+ | **Maintainability** | [↑ +X%] | [reducción complejidad/líneas] |
87
+
88
+ ---
89
+
90
+ ### 🔧 Tech Debt
91
+
92
+ **[Si aplica]:**
93
+
94
+ - ✅ Resuelto: TECH-DEBT #[N] - [descripción]
95
+ - 💰 Ahorro estimado: ~[X] horas futuras
96
+ - 📈 Métricas mejoradas: [complejidad ciclomática, líneas de código, etc.]
97
+
98
+ **[Si no aplica]:** _No hay tech debt asociado a esta tarea_
99
+
100
+ ---
101
+
102
+ ### 🔗 Referencias
103
+
104
+ - **Branch**: `[branch-name]`
105
+ - **Commits**: `[hash1]`, `[hash2]`, `[hash3]` ([N] total)
106
+ - **PR/MR**: [#XXX] o _Pendiente de crear_
107
+ - **Related**: [HU-XXX-XXX] / [Feature X.X] / _N/A_
108
+
109
+ ---
110
+
111
+ ## 📋 Guía de Mapeo por Plataforma
112
+
113
+ ### ClickUp
114
+
115
+ - **Título** → Task Name
116
+ - **Descripción** → Description (Markdown nativo)
117
+ - **Tags** → Custom Tags
118
+ - **Métricas** → Custom Fields (Time Tracked, Story Points)
119
+ - **Estado** → Status (Completado)
120
+
121
+ ### Jira
122
+
123
+ - **Título** → Summary
124
+ - **Descripción** → Description (formato Markdown/Wiki)
125
+ - **Tags** → Labels (separados por coma)
126
+ - **Story Points** → Story Points field
127
+ - **Branch** → Development panel (auto-link)
128
+
129
+ ### Linear
130
+
131
+ - **Título** → Issue Title
132
+ - **Descripción** → Full description
133
+ - **Tags** → Labels (auto-crear si no existen)
134
+ - **Métricas** → Custom fields o comentarios
135
+ - **Branch** → Git integration (auto-detect)
136
+
137
+ ### GitHub Projects
138
+
139
+ - **Título** → Issue/PR Title
140
+ - **Descripción** → Body
141
+ - **Tags** → Labels del repositorio
142
+ - **Métricas** → Task lists en descripción
143
+ - **Branch** → Linked branches
144
+
145
+ ### Azure DevOps
146
+
147
+ - **Título** → Work Item Title
148
+ - **Descripción** → Description (Rich Text)
149
+ - **Tags** → Tags field
150
+ - **Story Points** → Effort field
151
+ - **Branch** → Related Work Items
152
+
153
+ ### Trello
154
+
155
+ - **Título** → Card Name
156
+ - **Descripción** → Card Description
157
+ - **Tags** → Labels (colores personalizables)
158
+ - **Métricas** → Checklists o comentarios
159
+ - **Branch** → Attachments o Power-Ups
160
+
161
+ ### Asana
162
+
163
+ - **Título** → Task Name
164
+ - **Descripción** → Task Description
165
+ - **Tags** → Tags (auto-crear)
166
+ - **Métricas** → Custom Fields
167
+ - **Branch** → Comentarios o subtareas
168
+
169
+ ---
170
+
171
+ ## 🤖 Instrucciones de Población Automática
172
+
173
+ **Datos a extraer (fuentes):**
174
+
175
+ 1. **status.json**:
176
+ - `type` → Tipo de tarea (feature/refactor/fix)
177
+ - `timestamps.created` y `timestamps.completed` → Calcular duración
178
+ - `git.branchName` → Nombre de branch
179
+ - `git.commits[]` → Lista de commits
180
+ - `validation.*` → Resultados de tests, lint, typeCheck
181
+ - `progress.totalTasks` → Número de tareas
182
+
183
+ 2. **work.md**:
184
+ - Sección "Objective" → Párrafos de descripción
185
+ - Sección "Tasks" → Extraer Story Points (regex: `• (\d+) SP`)
186
+ - Suma total de SP
187
+
188
+ 3. **analytics.jsonl** (última línea):
189
+ - `dur` → Duración en minutos
190
+ - `sp` → Story Points
191
+ - `commits` → Número de commits
192
+ - `valid` → Validación exitosa
193
+
194
+ 4. **TECH-DEBT.md** (si existe antes de eliminar carpeta):
195
+ - Buscar secciones marcadas con ✅
196
+ - Extraer títulos y métricas de mejora
197
+
198
+ 5. **Git commands**:
199
+ - `git diff --stat [first-commit]~1..HEAD` → Archivos modificados (+/-líneas)
200
+ - `git log --oneline [branch]` → Hashes de commits
201
+ - `git log [branch] --grep="BREAKING CHANGE:"` → Detectar breaking changes
202
+
203
+ **Inferencia automática:**
204
+
205
+ ### Tags/Labels
206
+
207
+ - **Backend**: Si toca `src/modules/`, `src/core/`, `.service.ts`, `.controller.ts`
208
+ - **Frontend**: Si toca `components/`, `pages/`, `.tsx`, `.vue`, `.svelte`
209
+ - **API**: Si toca `.controller.ts`, `dto/`, `docs/api.md`
210
+ - **Database**: Si toca `entities/`, `migrations/`, `docs/database.md`
211
+ - **Security**: Si toca `guards/`, `auth/`, JWT, validation, `docs/security.md`
212
+ - **Performance**: Si menciona "optimization", "cache", "query", "N+1", "lazy load"
213
+ - **Testing**: Si agrega/modifica `*.spec.ts`, `*.test.ts`, `.e2e-spec.ts`
214
+ - **Documentation**: Si modifica `docs/*.md`, `README.md`, JSDoc, comments
215
+
216
+ ### Prioridad
217
+
218
+ - **Critical**: Si es fix de seguridad, vulnerabilidad, producción caída
219
+ - **High**: Si hay breaking changes, afecta usuarios finales, deadline cercano
220
+ - **Medium**: Features nuevos, mejoras significativas, refactors importantes
221
+ - **Low**: Refactors internos, documentación, tech debt menor
222
+
223
+ ### Scope
224
+
225
+ - Extraer del path principal modificado (ej: `src/modules/tenants/deliveries/` → Scope: "Deliveries")
226
+ - Si múltiples módulos: listar los 2-3 principales
227
+ - Patrón común: `src/modules/[global|tenants]/[scope-name]/`
228
+
229
+ ### Impacto
230
+
231
+ **UX ↑** (Mejora):
232
+
233
+ - Agrega/mejora endpoints públicos user-facing
234
+ - Reduce latencia/tiempo de respuesta
235
+ - Mejora mensajes de error/feedback
236
+ - Agrega features solicitadas por usuarios
237
+
238
+ **Security ↑** (Mejora):
239
+
240
+ - Agrega validaciones/constraints
241
+ - Implementa guards/middlewares
242
+ - Mejora JWT/auth handling
243
+ - Previene inyecciones SQL/XSS
244
+ - Agrega rate limiting/throttling
245
+
246
+ **Performance ↑** (Mejora):
247
+
248
+ - Reduce número de queries (N+1)
249
+ - Agrega cache/memoization
250
+ - Optimiza loops/algoritmos
251
+ - Implementa lazy loading/pagination
252
+
253
+ **Maintainability ↑** (Mejora):
254
+
255
+ - Refactoriza métodos largos (calcular % reducción líneas)
256
+ - Reduce complejidad ciclomática (antes vs después)
257
+ - Extrae responsabilidades (SRP)
258
+ - Mejora naming/estructura
259
+ - Agrega tests/documentación
260
+
261
+ **Cálculo de porcentaje de mejora**:
262
+
263
+ ```
264
+ Maintainability = ((líneas_antes - líneas_después) / líneas_antes) * 100
265
+ Ejemplo: (110 - 50) / 110 = 54.5% ≈ +55%
266
+ ```
267
+
268
+ ---
269
+
270
+ ## 📝 Notas de Implementación
271
+
272
+ - El template se llena automáticamente al ejecutar Phase 4 de `/flow-work`
273
+ - Campos opcionales: Si no hay datos, mostrar "_N/A_" o "_No aplica_"
274
+ - Breaking Changes: Solo mostrar si se detecta en commits
275
+ - Tech Debt: Solo mostrar sección si existe `TECH-DEBT.md`
276
+ - Todos los emojis son opcionales (quitar si la plataforma no los soporta)
277
+ - Formato Markdown es universal (todas las plataformas lo renderizan)
@@ -3,7 +3,9 @@
3
3
  > Universal AI Assistant Configuration
4
4
  >
5
5
  > This file provides context for ALL AI development tools (Claude, Copilot, Cursor, Gemini, etc.)
6
+
6
7
  ---
8
+
7
9
  ## 📋 About This Project
8
10
 
9
11
  **Project Name:** {{PROJECT_NAME}}
@@ -31,7 +33,9 @@
31
33
 
32
34
  > This project uses AI-assisted development with comprehensive documentation.
33
35
  > All files below provide context to AI assistants for consistent, high-quality code generation.
36
+
34
37
  ---
38
+
35
39
  ## 🏗️ Documentation Architecture
36
40
 
37
41
  This project follows **AI-assisted development** with comprehensive documentation.
@@ -109,7 +113,9 @@ All documentation is structured to guide AI assistants in understanding the proj
109
113
  - Required environment variables
110
114
  - Default/local values
111
115
  - Secrets handling guidance
116
+
112
117
  ---
118
+
113
119
  ## ⚡ Quick Reference
114
120
 
115
121
  ### Tech Stack
@@ -136,7 +142,9 @@ All documentation is structured to guide AI assistants in understanding the proj
136
142
 
137
143
  **✅ ALWAYS:**
138
144
  {{ALWAYS_RULES}}
145
+
139
146
  ---
147
+
140
148
  ## 🤖 AI Assistant Workflow
141
149
 
142
150
  When working on this project:
@@ -151,22 +159,24 @@ When working on this project:
151
159
  - Check relevant documentation for the area you're working on
152
160
  - Understand the business context from `project-brief.md`
153
161
 
154
- 2. **When implementing features:**
162
+ 3. **When implementing features:**
155
163
  - Follow architecture patterns from `docs/architecture.md`
156
164
  - Respect data models from `docs/data-model.md`
157
165
  - Apply code standards from `docs/code-standards.md`
158
166
  - Add tests according to `docs/testing.md`
159
167
 
160
- 3. **When handling security:**
168
+ 4. **When handling security:**
161
169
  - Consult `specs/security.md` for auth/authz
162
170
  - Never hardcode secrets (use `specs/configuration.md`)
163
171
  - Follow security headers and encryption requirements
164
172
 
165
- 4. **When deploying:**
173
+ 5. **When deploying:**
166
174
  - Follow procedures in `docs/operations.md`
167
175
  - Update configuration per environment
168
176
  - Check health endpoints
177
+
169
178
  ---
179
+
170
180
  ## 🛠️ Tool-Specific Configurations
171
181
 
172
182
  Different AI tools have specific configuration files that extend this AGENT.md:
@@ -189,16 +199,16 @@ Different AI tools have specific configuration files that extend this AGENT.md:
189
199
  - **Purpose:** Copilot workspace instructions
190
200
  - **References:** This AGENT.md + project docs
191
201
 
192
- **All tool-specific configs reference this AGENT.md as the source of truth.**
193
- ---
202
+ ## **All tool-specific configs reference this AGENT.md as the source of truth.**
203
+
194
204
  ## 📊 Project Status
195
205
 
196
206
  **Current Phase:** {{PROJECT_PHASE}}
197
207
 
198
208
  **Architecture:** {{ARCHITECTURE_PATTERN}}
199
209
 
200
- **Compliance:** {{COMPLIANCE_REQUIREMENTS}}
201
- ---
210
+ ## **Compliance:** {{COMPLIANCE_REQUIREMENTS}}
211
+
202
212
  ## 🚀 Getting Started
203
213
 
204
214
  ### For AI Assistants
@@ -211,16 +221,16 @@ Different AI tools have specific configuration files that extend this AGENT.md:
211
221
 
212
222
  ### For Developers
213
223
 
214
- See `README.md` for installation and setup instructions.
215
- ---
224
+ ## See `README.md` for installation and setup instructions.
225
+
216
226
  ## 📝 Document Update Policy
217
227
 
218
228
  - Documents are **living artifacts** - update as project evolves
219
229
  - Breaking changes to architecture → Update `docs/architecture.md`
220
- **Architecture:** {{ARCHITECTURE_PATTERN}}
221
- **Primary Language:** {{LANGUAGE}} {{LANGUAGE_VERSION}}
222
- **Framework:** {{FRAMEWORK}}
223
- **Database:** {{DATABASE}} with {{ORM}}
230
+ **Architecture:** {{ARCHITECTURE_PATTERN}}
231
+ **Primary Language:** {{LANGUAGE}} {{LANGUAGE_VERSION}}
232
+ **Framework:** {{FRAMEWORK}}
233
+ **Database:** {{DATABASE}} with {{ORM}}
224
234
 
225
235
  **Key Characteristics:**
226
236
 
@@ -231,7 +241,9 @@ See `README.md` for installation and setup instructions.
231
241
 
232
242
  > This project uses AI-assisted development with comprehensive documentation.
233
243
  > All files below provide context to AI assistants for consistent, high-quality code generation.
244
+
234
245
  ---
246
+
235
247
  ## 🏗️ Documentation Architecture
236
248
 
237
249
  This project follows **AI-assisted development** with comprehensive documentation.
@@ -309,7 +321,9 @@ All documentation is structured to guide AI assistants in understanding the proj
309
321
  - Required environment variables
310
322
  - Default/local values
311
323
  - Secrets handling guidance
324
+
312
325
  ---
326
+
313
327
  ## ⚡ Quick Reference
314
328
 
315
329
  ### Tech Stack
@@ -336,7 +350,9 @@ All documentation is structured to guide AI assistants in understanding the proj
336
350
 
337
351
  **✅ ALWAYS:**
338
352
  {{ALWAYS_RULES}}
353
+
339
354
  ---
355
+
340
356
  ## 🤖 AI Assistant Workflow
341
357
 
342
358
  When working on this project:
@@ -351,22 +367,24 @@ When working on this project:
351
367
  - Check relevant documentation for the area you're working on
352
368
  - Understand the business context from `project-brief.md`
353
369
 
354
- 2. **When implementing features:**
370
+ 3. **When implementing features:**
355
371
  - Follow architecture patterns from `docs/architecture.md`
356
372
  - Respect data models from `docs/data-model.md`
357
373
  - Apply code standards from `docs/code-standards.md`
358
374
  - Add tests according to `docs/testing.md`
359
375
 
360
- 3. **When handling security:**
376
+ 4. **When handling security:**
361
377
  - Consult `specs/security.md` for auth/authz
362
378
  - Never hardcode secrets (use `specs/configuration.md`)
363
379
  - Follow security headers and encryption requirements
364
380
 
365
- 4. **When deploying:**
381
+ 5. **When deploying:**
366
382
  - Follow procedures in `docs/operations.md`
367
383
  - Update configuration per environment
368
384
  - Check health endpoints
385
+
369
386
  ---
387
+
370
388
  ## 🛠️ Tool-Specific Configurations
371
389
 
372
390
  Different AI tools have specific configuration files that extend this AGENT.md:
@@ -389,16 +407,16 @@ Different AI tools have specific configuration files that extend this AGENT.md:
389
407
  - **Purpose:** Copilot workspace instructions
390
408
  - **References:** This AGENT.md + project docs
391
409
 
392
- **All tool-specific configs reference this AGENT.md as the source of truth.**
393
- ---
410
+ ## **All tool-specific configs reference this AGENT.md as the source of truth.**
411
+
394
412
  ## 📊 Project Status
395
413
 
396
414
  **Current Phase:** {{PROJECT_PHASE}}
397
415
 
398
416
  **Architecture:** {{ARCHITECTURE_PATTERN}}
399
417
 
400
- **Compliance:** {{COMPLIANCE_REQUIREMENTS}}
401
- ---
418
+ ## **Compliance:** {{COMPLIANCE_REQUIREMENTS}}
419
+
402
420
  ## 🚀 Getting Started
403
421
 
404
422
  ### For AI Assistants
@@ -411,8 +429,8 @@ Different AI tools have specific configuration files that extend this AGENT.md:
411
429
 
412
430
  ### For Developers
413
431
 
414
- See `README.md` for installation and setup instructions.
415
- ---
432
+ ## See `README.md` for installation and setup instructions.
433
+
416
434
  ## 📝 Document Update Policy
417
435
 
418
436
  - Documents are **living artifacts** - update as project evolves
@@ -422,4 +440,4 @@ See `README.md` for installation and setup instructions.
422
440
 
423
441
  **Last Updated:** {{GENERATION_DATE}}
424
442
 
425
- **Generated by:** AI Flow v2.2.4
443
+ **Generated by:** AI Flow v2.5.2
@@ -1,112 +1,112 @@
1
- # Claude Code Configuration for {{PROJECT_NAME}}
2
-
3
- ## 📋 Quick Start
4
-
5
- **IMPORTANT:** Read `AGENT.md` first for complete project context.
6
-
7
- This file contains Claude Code-specific preferences and workflows.
8
-
9
- ---
10
-
11
- ## 🎯 Project Summary
12
-
13
- **Name:** {{PROJECT_NAME}}
14
-
15
- **Description:** {{PROJECT_DESCRIPTION}}
16
-
17
- **Stack:** {{FRAMEWORK}} + {{LANGUAGE}} + {{DATABASE}}
18
-
19
- ---
20
-
21
- ## 📚 Documentation Architecture
22
-
23
- **Always reference these files in order:**
24
-
25
- 1. `AGENT.md` - Universal AI configuration (READ FIRST)
26
- 2. `ai-instructions.md` - Tech stack, rules, workflow
27
- 3. `project-brief.md` - Business context
28
- 4. `README.md` - Developer onboarding & commands
29
- 5. `docs/architecture.md` - System architecture
30
- 6. `docs/data-model.md` - Database design
31
- 7. `docs/code-standards.md` - Code quality standards
32
- 8. `docs/testing.md` - Testing strategy
33
- 9. `docs/operations.md` - Deployment & operational procedures
34
- 10. `docs/business-flows.md` - Business process flows and diagrams
35
- 11. `docs/api.md` - API reference and conventions
36
- 12. `docs/contributing.md` - Contribution workflow
37
- 13. `specs/security.md` - Security policies
38
- 14. `specs/configuration.md` - Environment config
39
-
40
- ---
41
-
42
- ## ❌ CRITICAL RULES - NEVER
43
-
44
- {{NEVER_RULES_SUMMARY}}
45
-
46
- ---
47
-
48
- ## ✅ CRITICAL RULES - ALWAYS
49
-
50
- {{ALWAYS_RULES_SUMMARY}}
51
-
52
- ---
53
-
54
- ## 🏗️ Architecture Pattern
55
-
56
- **Pattern:** {{ARCHITECTURE_PATTERN}}
57
-
58
- **File Organization:** {{FILE_ORGANIZATION}}
59
-
60
- ---
61
-
62
- ## 🧪 Testing Requirements
63
-
64
- - Minimum {{MIN_COVERAGE}}% coverage
65
- - Write tests for all new features
66
- - Run tests before committing: `{{TEST_COMMAND}}`
67
-
68
- ---
69
-
70
- ## 📝 Commit Format
71
-
72
- {{COMMIT_FORMAT_EXAMPLE}}
73
-
74
- ---
75
-
76
- ## 🚀 Claude Code Workflow
77
-
78
- ### Workflow Modes
79
- 1. **🚀 Forced Agent Mode:** When running any command starting with `/flow-`, **IMMEDIATELY enter AGENT/EXECUTION MODE**. Do not wait for a general plan approval.
80
- 2. **Plan Mode:** Use plan mode for complex *custom* features that are not part of the standard `ai-flow` commands.
81
- 3. Break down custom features into small, testable chunks.
82
- 4. Get user approval before implementation for custom features.
83
-
84
- ### Implementation
85
- 1. Follow architecture patterns strictly
86
- 2. Write tests alongside code
87
- 3. Update documentation if behavior changes
88
-
89
- ---
90
-
91
- ## 🔒 Security Checklist
92
-
93
- - [ ] Input validation with {{VALIDATION_LIBRARY}}
94
- - [ ] Authentication/authorization checked
95
- - [ ] No hardcoded secrets
96
- - [ ] No sensitive data in logs
97
- - [ ] Rate limiting for public endpoints
98
-
99
- ---
100
-
101
- ## 💡 Claude-Specific Tips
102
-
103
- - Use `/flow-build` command for starting documentation generation
104
- - Use plan mode for architectural decisions
105
- - Reference `AGENT.md` for any clarifications
106
- - Ask user before making breaking changes
107
-
108
- ---
109
-
110
- **For full context, always read `AGENT.md` and `ai-instructions.md` before starting work.**
111
-
112
- **Generated by:** AI Flow v1.0.0
1
+ # Claude Code Configuration for {{PROJECT_NAME}}
2
+
3
+ ## 📋 Quick Start
4
+
5
+ **IMPORTANT:** Read `AGENT.md` first for complete project context.
6
+
7
+ This file contains Claude Code-specific preferences and workflows.
8
+
9
+ ---
10
+
11
+ ## 🎯 Project Summary
12
+
13
+ **Name:** {{PROJECT_NAME}}
14
+
15
+ **Description:** {{PROJECT_DESCRIPTION}}
16
+
17
+ **Stack:** {{FRAMEWORK}} + {{LANGUAGE}} + {{DATABASE}}
18
+
19
+ ---
20
+
21
+ ## 📚 Documentation Architecture
22
+
23
+ **Always reference these files in order:**
24
+
25
+ 1. `AGENT.md` - Universal AI configuration (READ FIRST)
26
+ 2. `ai-instructions.md` - Tech stack, rules, workflow
27
+ 3. `project-brief.md` - Business context
28
+ 4. `README.md` - Developer onboarding & commands
29
+ 5. `docs/architecture.md` - System architecture
30
+ 6. `docs/data-model.md` - Database design
31
+ 7. `docs/code-standards.md` - Code quality standards
32
+ 8. `docs/testing.md` - Testing strategy
33
+ 9. `docs/operations.md` - Deployment & operational procedures
34
+ 10. `docs/business-flows.md` - Business process flows and diagrams
35
+ 11. `docs/api.md` - API reference and conventions
36
+ 12. `docs/contributing.md` - Contribution workflow
37
+ 13. `specs/security.md` - Security policies
38
+ 14. `specs/configuration.md` - Environment config
39
+
40
+ ---
41
+
42
+ ## ❌ CRITICAL RULES - NEVER
43
+
44
+ {{NEVER_RULES_SUMMARY}}
45
+
46
+ ---
47
+
48
+ ## ✅ CRITICAL RULES - ALWAYS
49
+
50
+ {{ALWAYS_RULES_SUMMARY}}
51
+
52
+ ---
53
+
54
+ ## 🏗️ Architecture Pattern
55
+
56
+ **Pattern:** {{ARCHITECTURE_PATTERN}}
57
+
58
+ **File Organization:** {{FILE_ORGANIZATION}}
59
+
60
+ ---
61
+
62
+ ## 🧪 Testing Requirements
63
+
64
+ - Minimum {{MIN_COVERAGE}}% coverage
65
+ - Write tests for all new features
66
+ - Run tests before committing: `{{TEST_COMMAND}}`
67
+
68
+ ---
69
+
70
+ ## 📝 Commit Format
71
+
72
+ {{COMMIT_FORMAT_EXAMPLE}}
73
+
74
+ ---
75
+
76
+ ## 🚀 Claude Code Workflow
77
+
78
+ ### Workflow Modes
79
+ 1. **🚀 Forced Agent Mode:** When running any command starting with `/flow-`, **IMMEDIATELY enter AGENT/EXECUTION MODE**. Do not wait for a general plan approval.
80
+ 2. **Plan Mode:** Use plan mode for complex *custom* features that are not part of the standard `ai-flow` commands.
81
+ 3. Break down custom features into small, testable chunks.
82
+ 4. Get user approval before implementation for custom features.
83
+
84
+ ### Implementation
85
+ 1. Follow architecture patterns strictly
86
+ 2. Write tests alongside code
87
+ 3. Update documentation if behavior changes
88
+
89
+ ---
90
+
91
+ ## 🔒 Security Checklist
92
+
93
+ - [ ] Input validation with {{VALIDATION_LIBRARY}}
94
+ - [ ] Authentication/authorization checked
95
+ - [ ] No hardcoded secrets
96
+ - [ ] No sensitive data in logs
97
+ - [ ] Rate limiting for public endpoints
98
+
99
+ ---
100
+
101
+ ## 💡 Claude-Specific Tips
102
+
103
+ - Use `/flow-build` command for starting documentation generation
104
+ - Use plan mode for architectural decisions
105
+ - Reference `AGENT.md` for any clarifications
106
+ - Ask user before making breaking changes
107
+
108
+ ---
109
+
110
+ **For full context, always read `AGENT.md` and `ai-instructions.md` before starting work.**
111
+
112
+ **Generated by:** AI Flow v1.0.0