create-universal-ai-context 2.5.0 → 2.6.0-final

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.
Files changed (153) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +331 -294
  3. package/bin/create-ai-context.js +1507 -775
  4. package/lib/adapters/aider.js +131 -131
  5. package/lib/adapters/antigravity.js +205 -205
  6. package/lib/adapters/claude.js +397 -397
  7. package/lib/adapters/cline.js +125 -125
  8. package/lib/adapters/continue.js +138 -138
  9. package/lib/adapters/copilot.js +131 -131
  10. package/lib/adapters/index.js +78 -78
  11. package/lib/adapters/windsurf.js +138 -138
  12. package/lib/ai-context-generator.js +234 -234
  13. package/lib/ai-orchestrator.js +432 -432
  14. package/lib/call-tracer.js +444 -444
  15. package/lib/content-preservation.js +243 -243
  16. package/lib/cross-tool-sync/file-watcher.js +274 -274
  17. package/lib/cross-tool-sync/index.js +41 -40
  18. package/lib/cross-tool-sync/sync-manager.js +540 -512
  19. package/lib/cross-tool-sync/sync-service.js +297 -297
  20. package/lib/detector.js +726 -726
  21. package/lib/doc-discovery.js +741 -741
  22. package/lib/drift-checker.js +920 -920
  23. package/lib/environment-detector.js +239 -239
  24. package/lib/index.js +399 -399
  25. package/lib/install-hooks.js +82 -82
  26. package/lib/installer.js +419 -419
  27. package/lib/migrate.js +328 -328
  28. package/lib/placeholder.js +632 -632
  29. package/lib/prompts.js +341 -341
  30. package/lib/smart-merge.js +540 -540
  31. package/lib/spinner.js +60 -60
  32. package/lib/static-analyzer.js +729 -729
  33. package/lib/template-coordination.js +148 -148
  34. package/lib/template-populator.js +843 -843
  35. package/lib/template-renderer.js +392 -392
  36. package/lib/utils/fs-wrapper.js +79 -79
  37. package/lib/utils/path-utils.js +60 -60
  38. package/lib/validate.js +155 -155
  39. package/package.json +1 -1
  40. package/templates/AI_CONTEXT.md.template +245 -245
  41. package/templates/base/README.md +260 -257
  42. package/templates/base/RPI_WORKFLOW_PLAN.md +325 -320
  43. package/templates/base/agents/api-developer.md +76 -76
  44. package/templates/base/agents/context-engineer.md +525 -525
  45. package/templates/base/agents/core-architect.md +76 -76
  46. package/templates/base/agents/database-ops.md +76 -76
  47. package/templates/base/agents/deployment-ops.md +76 -76
  48. package/templates/base/agents/integration-hub.md +76 -76
  49. package/templates/base/analytics/README.md +114 -114
  50. package/templates/base/automation/config.json +58 -58
  51. package/templates/base/automation/generators/code-mapper.js +308 -308
  52. package/templates/base/automation/generators/index-builder.js +321 -321
  53. package/templates/base/automation/hooks/post-commit.sh +83 -83
  54. package/templates/base/automation/hooks/pre-commit.sh +103 -103
  55. package/templates/base/ci-templates/README.md +108 -108
  56. package/templates/base/ci-templates/github-actions/context-check.yml +144 -144
  57. package/templates/base/ci-templates/github-actions/validate-docs.yml +105 -105
  58. package/templates/base/commands/analytics.md +238 -238
  59. package/templates/base/commands/auto-sync.md +172 -172
  60. package/templates/base/commands/collab.md +194 -194
  61. package/templates/base/commands/context-optimize.md +226 -0
  62. package/templates/base/commands/help.md +485 -450
  63. package/templates/base/commands/rpi-implement.md +164 -115
  64. package/templates/base/commands/rpi-plan.md +147 -93
  65. package/templates/base/commands/rpi-research.md +145 -88
  66. package/templates/base/commands/session-resume.md +144 -144
  67. package/templates/base/commands/session-save.md +112 -112
  68. package/templates/base/commands/validate-all.md +77 -77
  69. package/templates/base/commands/verify-docs-current.md +86 -86
  70. package/templates/base/config/base.json +57 -57
  71. package/templates/base/config/environments/development.json +13 -13
  72. package/templates/base/config/environments/production.json +17 -17
  73. package/templates/base/config/environments/staging.json +13 -13
  74. package/templates/base/config/local.json.example +21 -21
  75. package/templates/base/context/.meta/generated-at.json +18 -18
  76. package/templates/base/context/ARCHITECTURE_SNAPSHOT.md +156 -156
  77. package/templates/base/context/CODE_TO_WORKFLOW_MAP.md +94 -94
  78. package/templates/base/context/FILE_OWNERSHIP.md +57 -57
  79. package/templates/base/context/INTEGRATION_POINTS.md +92 -92
  80. package/templates/base/context/KNOWN_GOTCHAS.md +195 -195
  81. package/templates/base/context/TESTING_MAP.md +95 -95
  82. package/templates/base/context/WORKFLOW_INDEX.md +129 -129
  83. package/templates/base/context/workflows/WORKFLOW_TEMPLATE.md +294 -294
  84. package/templates/base/indexes/agents/CAPABILITY_MATRIX.md +255 -255
  85. package/templates/base/indexes/agents/CATEGORY_INDEX.md +44 -44
  86. package/templates/base/indexes/code/CATEGORY_INDEX.md +38 -38
  87. package/templates/base/indexes/routing/CATEGORY_INDEX.md +39 -39
  88. package/templates/base/indexes/search/CATEGORY_INDEX.md +39 -39
  89. package/templates/base/indexes/workflows/CATEGORY_INDEX.md +38 -38
  90. package/templates/base/knowledge/README.md +98 -98
  91. package/templates/base/knowledge/sessions/README.md +88 -88
  92. package/templates/base/knowledge/sessions/TEMPLATE.md +150 -150
  93. package/templates/base/knowledge/shared/decisions/0001-adopt-context-engineering.md +144 -144
  94. package/templates/base/knowledge/shared/decisions/README.md +49 -49
  95. package/templates/base/knowledge/shared/decisions/TEMPLATE.md +123 -123
  96. package/templates/base/knowledge/shared/patterns/README.md +62 -62
  97. package/templates/base/knowledge/shared/patterns/TEMPLATE.md +120 -120
  98. package/templates/base/plans/PLAN_TEMPLATE.md +316 -250
  99. package/templates/base/research/RESEARCH_TEMPLATE.md +245 -153
  100. package/templates/base/schemas/agent.schema.json +141 -141
  101. package/templates/base/schemas/anchors.schema.json +54 -54
  102. package/templates/base/schemas/automation.schema.json +93 -93
  103. package/templates/base/schemas/command.schema.json +134 -134
  104. package/templates/base/schemas/hashes.schema.json +40 -40
  105. package/templates/base/schemas/manifest.schema.json +117 -117
  106. package/templates/base/schemas/plan.schema.json +136 -136
  107. package/templates/base/schemas/research.schema.json +115 -115
  108. package/templates/base/schemas/roles.schema.json +34 -34
  109. package/templates/base/schemas/session.schema.json +77 -77
  110. package/templates/base/schemas/settings.schema.json +244 -244
  111. package/templates/base/schemas/staleness.schema.json +53 -53
  112. package/templates/base/schemas/team-config.schema.json +42 -42
  113. package/templates/base/schemas/workflow.schema.json +126 -126
  114. package/templates/base/session/checkpoints/.gitkeep +2 -2
  115. package/templates/base/session/current/state.json +20 -20
  116. package/templates/base/session/history/.gitkeep +2 -2
  117. package/templates/base/settings.json +3 -3
  118. package/templates/base/standards/COMPATIBILITY.md +219 -219
  119. package/templates/base/standards/EXTENSION_GUIDELINES.md +280 -280
  120. package/templates/base/standards/QUALITY_CHECKLIST.md +211 -211
  121. package/templates/base/standards/README.md +66 -66
  122. package/templates/base/sync/anchors.json +6 -6
  123. package/templates/base/sync/hashes.json +6 -6
  124. package/templates/base/sync/staleness.json +10 -10
  125. package/templates/base/team/README.md +168 -168
  126. package/templates/base/team/config.json +79 -79
  127. package/templates/base/team/roles.json +145 -145
  128. package/templates/base/tools/bin/claude-context.js +151 -151
  129. package/templates/base/tools/lib/anchor-resolver.js +276 -276
  130. package/templates/base/tools/lib/config-loader.js +363 -363
  131. package/templates/base/tools/lib/detector.js +350 -350
  132. package/templates/base/tools/lib/diagnose.js +206 -206
  133. package/templates/base/tools/lib/drift-detector.js +373 -373
  134. package/templates/base/tools/lib/errors.js +199 -199
  135. package/templates/base/tools/lib/index.js +36 -36
  136. package/templates/base/tools/lib/init.js +192 -192
  137. package/templates/base/tools/lib/logger.js +230 -230
  138. package/templates/base/tools/lib/placeholder.js +201 -201
  139. package/templates/base/tools/lib/session-manager.js +354 -354
  140. package/templates/base/tools/lib/validate.js +521 -521
  141. package/templates/base/tools/package.json +49 -49
  142. package/templates/handlebars/aider-config.hbs +146 -80
  143. package/templates/handlebars/antigravity.hbs +377 -377
  144. package/templates/handlebars/claude.hbs +183 -183
  145. package/templates/handlebars/cline.hbs +62 -62
  146. package/templates/handlebars/continue-config.hbs +116 -116
  147. package/templates/handlebars/copilot.hbs +130 -130
  148. package/templates/handlebars/partials/gotcha-list.hbs +11 -11
  149. package/templates/handlebars/partials/header.hbs +3 -3
  150. package/templates/handlebars/partials/workflow-summary.hbs +16 -16
  151. package/templates/handlebars/windsurf-rules.hbs +69 -69
  152. package/templates/hooks/post-commit.hbs +28 -29
  153. package/templates/hooks/pre-commit.hbs +46 -46
@@ -1,57 +1,57 @@
1
- # File Ownership Map
2
-
3
- > Maps source files to their primary owners/maintainers.
4
- > **Last Updated:** {{LAST_UPDATED}}
5
-
6
- ---
7
-
8
- ## Overview
9
-
10
- This document tracks file ownership for the codebase. When modifying files, check with the owner for context on design decisions and constraints.
11
-
12
- ---
13
-
14
- ## Ownership Categories
15
-
16
- ### Core Files
17
-
18
- | File/Directory | Owner | Notes |
19
- |----------------|-------|-------|
20
- | `src/` | {{OWNER}} | Main application code |
21
- | `tests/` | {{OWNER}} | Test suites |
22
- | `docs/` | {{OWNER}} | Documentation |
23
-
24
- ### Configuration
25
-
26
- | File | Owner | Notes |
27
- |------|-------|-------|
28
- | `package.json` | {{OWNER}} | Dependencies and scripts |
29
- | `.ai-context/` | {{OWNER}} | Claude Code configuration |
30
-
31
- ### Infrastructure
32
-
33
- | File/Directory | Owner | Notes |
34
- |----------------|-------|-------|
35
- | `.github/` | {{OWNER}} | CI/CD workflows |
36
- | `Dockerfile` | {{OWNER}} | Container configuration |
37
-
38
- ---
39
-
40
- ## How to Use
41
-
42
- 1. **Before major changes**: Contact the file owner
43
- 2. **Adding new files**: Update this map
44
- 3. **Transferring ownership**: Document the handoff
45
-
46
- ---
47
-
48
- ## Maintenance
49
-
50
- Update this file when:
51
- - New files/directories are added
52
- - Ownership changes
53
- - Team members join/leave
54
-
55
- ---
56
-
57
- *Template file - populate with actual ownership data*
1
+ # File Ownership Map
2
+
3
+ > Maps source files to their primary owners/maintainers.
4
+ > **Last Updated:** {{LAST_UPDATED}}
5
+
6
+ ---
7
+
8
+ ## Overview
9
+
10
+ This document tracks file ownership for the codebase. When modifying files, check with the owner for context on design decisions and constraints.
11
+
12
+ ---
13
+
14
+ ## Ownership Categories
15
+
16
+ ### Core Files
17
+
18
+ | File/Directory | Owner | Notes |
19
+ |----------------|-------|-------|
20
+ | `src/` | {{OWNER}} | Main application code |
21
+ | `tests/` | {{OWNER}} | Test suites |
22
+ | `docs/` | {{OWNER}} | Documentation |
23
+
24
+ ### Configuration
25
+
26
+ | File | Owner | Notes |
27
+ |------|-------|-------|
28
+ | `package.json` | {{OWNER}} | Dependencies and scripts |
29
+ | `.ai-context/` | {{OWNER}} | Claude Code configuration |
30
+
31
+ ### Infrastructure
32
+
33
+ | File/Directory | Owner | Notes |
34
+ |----------------|-------|-------|
35
+ | `.github/` | {{OWNER}} | CI/CD workflows |
36
+ | `Dockerfile` | {{OWNER}} | Container configuration |
37
+
38
+ ---
39
+
40
+ ## How to Use
41
+
42
+ 1. **Before major changes**: Contact the file owner
43
+ 2. **Adding new files**: Update this map
44
+ 3. **Transferring ownership**: Document the handoff
45
+
46
+ ---
47
+
48
+ ## Maintenance
49
+
50
+ Update this file when:
51
+ - New files/directories are added
52
+ - Ownership changes
53
+ - Team members join/leave
54
+
55
+ ---
56
+
57
+ *Template file - populate with actual ownership data*
@@ -1,92 +1,92 @@
1
- # Integration Points
2
-
3
- > Documents external systems, APIs, and integration boundaries.
4
- > **Last Updated:** {{LAST_UPDATED}}
5
-
6
- ---
7
-
8
- ## Overview
9
-
10
- This document maps all integration points where our system connects with external services, APIs, or systems.
11
-
12
- ---
13
-
14
- ## External APIs
15
-
16
- ### {{API_NAME}}
17
-
18
- | Property | Value |
19
- |----------|-------|
20
- | **Base URL** | `{{API_URL}}` |
21
- | **Authentication** | {{AUTH_METHOD}} |
22
- | **Rate Limits** | {{RATE_LIMITS}} |
23
- | **Documentation** | {{DOCS_URL}} |
24
-
25
- **Used By:**
26
- - `src/services/{{service}}.{{ext}}`
27
-
28
- **Gotchas:**
29
- - {{GOTCHA_1}}
30
-
31
- ---
32
-
33
- ## Databases
34
-
35
- ### {{DATABASE_NAME}}
36
-
37
- | Property | Value |
38
- |----------|-------|
39
- | **Type** | {{DB_TYPE}} |
40
- | **Connection** | {{CONNECTION_STRING}} |
41
- | **Migrations** | `{{MIGRATIONS_PATH}}` |
42
-
43
- ---
44
-
45
- ## Message Queues
46
-
47
- ### {{QUEUE_NAME}}
48
-
49
- | Property | Value |
50
- |----------|-------|
51
- | **Type** | {{QUEUE_TYPE}} |
52
- | **Topics** | {{TOPICS}} |
53
-
54
- ---
55
-
56
- ## Third-Party Services
57
-
58
- | Service | Purpose | Config Location |
59
- |---------|---------|-----------------|
60
- | {{SERVICE}} | {{PURPOSE}} | `{{CONFIG_PATH}}` |
61
-
62
- ---
63
-
64
- ## Internal Boundaries
65
-
66
- ### Microservice Communication
67
-
68
- | Service A | Service B | Protocol | Notes |
69
- |-----------|-----------|----------|-------|
70
- | {{SVC_A}} | {{SVC_B}} | {{PROTOCOL}} | {{NOTES}} |
71
-
72
- ---
73
-
74
- ## Authentication Flows
75
-
76
- ```
77
- {{AUTH_FLOW_DIAGRAM}}
78
- ```
79
-
80
- ---
81
-
82
- ## Maintenance
83
-
84
- Update this file when:
85
- - New integrations are added
86
- - API endpoints change
87
- - Authentication methods update
88
- - New services are introduced
89
-
90
- ---
91
-
92
- *Template file - populate with actual integration data*
1
+ # Integration Points
2
+
3
+ > Documents external systems, APIs, and integration boundaries.
4
+ > **Last Updated:** {{LAST_UPDATED}}
5
+
6
+ ---
7
+
8
+ ## Overview
9
+
10
+ This document maps all integration points where our system connects with external services, APIs, or systems.
11
+
12
+ ---
13
+
14
+ ## External APIs
15
+
16
+ ### {{API_NAME}}
17
+
18
+ | Property | Value |
19
+ |----------|-------|
20
+ | **Base URL** | `{{API_URL}}` |
21
+ | **Authentication** | {{AUTH_METHOD}} |
22
+ | **Rate Limits** | {{RATE_LIMITS}} |
23
+ | **Documentation** | {{DOCS_URL}} |
24
+
25
+ **Used By:**
26
+ - `src/services/{{service}}.{{ext}}`
27
+
28
+ **Gotchas:**
29
+ - {{GOTCHA_1}}
30
+
31
+ ---
32
+
33
+ ## Databases
34
+
35
+ ### {{DATABASE_NAME}}
36
+
37
+ | Property | Value |
38
+ |----------|-------|
39
+ | **Type** | {{DB_TYPE}} |
40
+ | **Connection** | {{CONNECTION_STRING}} |
41
+ | **Migrations** | `{{MIGRATIONS_PATH}}` |
42
+
43
+ ---
44
+
45
+ ## Message Queues
46
+
47
+ ### {{QUEUE_NAME}}
48
+
49
+ | Property | Value |
50
+ |----------|-------|
51
+ | **Type** | {{QUEUE_TYPE}} |
52
+ | **Topics** | {{TOPICS}} |
53
+
54
+ ---
55
+
56
+ ## Third-Party Services
57
+
58
+ | Service | Purpose | Config Location |
59
+ |---------|---------|-----------------|
60
+ | {{SERVICE}} | {{PURPOSE}} | `{{CONFIG_PATH}}` |
61
+
62
+ ---
63
+
64
+ ## Internal Boundaries
65
+
66
+ ### Microservice Communication
67
+
68
+ | Service A | Service B | Protocol | Notes |
69
+ |-----------|-----------|----------|-------|
70
+ | {{SVC_A}} | {{SVC_B}} | {{PROTOCOL}} | {{NOTES}} |
71
+
72
+ ---
73
+
74
+ ## Authentication Flows
75
+
76
+ ```
77
+ {{AUTH_FLOW_DIAGRAM}}
78
+ ```
79
+
80
+ ---
81
+
82
+ ## Maintenance
83
+
84
+ Update this file when:
85
+ - New integrations are added
86
+ - API endpoints change
87
+ - Authentication methods update
88
+ - New services are introduced
89
+
90
+ ---
91
+
92
+ *Template file - populate with actual integration data*
@@ -1,195 +1,195 @@
1
- # Known Gotchas - {{PROJECT_NAME}}
2
-
3
- **Purpose:** Document lessons learned, common pitfalls, and their solutions
4
- **Use:** Before implementing features or debugging issues
5
- **Size:** ~15k tokens (grows over time)
6
- **Last Updated:** {{DATE}}
7
-
8
- ---
9
-
10
- ## How to Use This File
11
-
12
- 1. **Before implementing:** Search for related gotchas
13
- 2. **After fixing bugs:** Add new gotchas
14
- 3. **During code review:** Reference relevant gotchas
15
- 4. **Quarterly:** Review and archive resolved gotchas
16
-
17
- ---
18
-
19
- ## Gotcha Categories
20
-
21
- 1. [Database](#database-gotchas)
22
- 2. [API](#api-gotchas)
23
- 3. [Authentication](#authentication-gotchas)
24
- 4. [External Services](#external-services-gotchas)
25
- 5. [Testing](#testing-gotchas)
26
- 6. [Deployment](#deployment-gotchas)
27
-
28
- ---
29
-
30
- ## Database Gotchas
31
-
32
- ### GOTCHA-DB-001: {{GOTCHA_TITLE}}
33
-
34
- **Severity:** CRITICAL / HIGH / MEDIUM / LOW
35
- **Discovered:** {{DATE}}
36
- **Workflow Impact:** [workflow_1.md](./workflows/workflow_1.md)
37
-
38
- **Symptom:**
39
- {{WHAT_GOES_WRONG}}
40
-
41
- **Root Cause:**
42
- {{WHY_IT_HAPPENS}}
43
-
44
- **Fix:**
45
- ```
46
- {{CODE_OR_STEPS_TO_FIX}}
47
- ```
48
-
49
- **Prevention:**
50
- - {{HOW_TO_AVOID_IN_FUTURE}}
51
-
52
- ---
53
-
54
- ### GOTCHA-DB-002: {{GOTCHA_TITLE}}
55
-
56
- [Same structure...]
57
-
58
- ---
59
-
60
- ## API Gotchas
61
-
62
- ### GOTCHA-API-001: {{GOTCHA_TITLE}}
63
-
64
- **Severity:** CRITICAL / HIGH / MEDIUM / LOW
65
- **Discovered:** {{DATE}}
66
- **Workflow Impact:** [workflow_2.md](./workflows/workflow_2.md)
67
-
68
- **Symptom:**
69
- {{WHAT_GOES_WRONG}}
70
-
71
- **Root Cause:**
72
- {{WHY_IT_HAPPENS}}
73
-
74
- **Fix:**
75
- ```
76
- {{CODE_OR_STEPS_TO_FIX}}
77
- ```
78
-
79
- **Prevention:**
80
- - {{HOW_TO_AVOID_IN_FUTURE}}
81
-
82
- ---
83
-
84
- ## Authentication Gotchas
85
-
86
- ### GOTCHA-AUTH-001: {{GOTCHA_TITLE}}
87
-
88
- [Same structure...]
89
-
90
- ---
91
-
92
- ## External Services Gotchas
93
-
94
- ### GOTCHA-EXT-001: {{GOTCHA_TITLE}}
95
-
96
- [Same structure...]
97
-
98
- ---
99
-
100
- ## Testing Gotchas
101
-
102
- ### GOTCHA-TEST-001: {{GOTCHA_TITLE}}
103
-
104
- [Same structure...]
105
-
106
- ---
107
-
108
- ## Deployment Gotchas
109
-
110
- ### GOTCHA-DEPLOY-001: {{GOTCHA_TITLE}}
111
-
112
- [Same structure...]
113
-
114
- ---
115
-
116
- ## Quick Reference Table
117
-
118
- | ID | Title | Severity | Workflow |
119
- |----|-------|----------|----------|
120
- | DB-001 | {{TITLE}} | {{SEVERITY}} | workflow_1 |
121
- | API-001 | {{TITLE}} | {{SEVERITY}} | workflow_2 |
122
- | AUTH-001 | {{TITLE}} | {{SEVERITY}} | workflow_3 |
123
-
124
- ---
125
-
126
- ## Adding New Gotchas
127
-
128
- ### Template
129
-
130
- ```markdown
131
- ### GOTCHA-[CATEGORY]-[NUMBER]: [Title]
132
-
133
- **Severity:** CRITICAL / HIGH / MEDIUM / LOW
134
- **Discovered:** YYYY-MM-DD
135
- **Workflow Impact:** [workflow_name.md](./workflows/workflow_name.md)
136
-
137
- **Symptom:**
138
- [What the user/developer observes going wrong]
139
-
140
- **Root Cause:**
141
- [Technical explanation of why it happens]
142
-
143
- **Fix:**
144
- ```
145
- [Code or steps to fix]
146
- ```
147
-
148
- **Prevention:**
149
- - [How to avoid this in future code]
150
- - [What patterns to use instead]
151
- ```
152
-
153
- ### Categories
154
-
155
- - **DB**: Database, migrations, queries
156
- - **API**: REST endpoints, request/response
157
- - **AUTH**: Authentication, authorization, sessions
158
- - **EXT**: External services, APIs, integrations
159
- - **TEST**: Testing, mocking, fixtures
160
- - **DEPLOY**: Deployment, CI/CD, infrastructure
161
-
162
- ### Severity Levels
163
-
164
- | Level | Definition |
165
- |-------|------------|
166
- | CRITICAL | Production down, data loss possible |
167
- | HIGH | Feature broken, workaround difficult |
168
- | MEDIUM | Feature degraded, workaround exists |
169
- | LOW | Minor inconvenience, edge case |
170
-
171
- ---
172
-
173
- ## Archived Gotchas
174
-
175
- Gotchas that are fully resolved and no longer relevant:
176
-
177
- | ID | Title | Resolved Date | Resolution |
178
- |----|-------|---------------|------------|
179
- | - | - | - | - |
180
-
181
- ---
182
-
183
- ## Statistics
184
-
185
- - **Total Active Gotchas:** {{TOTAL_COUNT}}
186
- - **Critical:** {{CRITICAL_COUNT}}
187
- - **High:** {{HIGH_COUNT}}
188
- - **Medium:** {{MEDIUM_COUNT}}
189
- - **Low:** {{LOW_COUNT}}
190
- - **Last Added:** {{LAST_ADDED_DATE}}
191
-
192
- ---
193
-
194
- **Version:** 1.0
195
- **Maintainer:** {{MAINTAINER}}
1
+ # Known Gotchas - {{PROJECT_NAME}}
2
+
3
+ **Purpose:** Document lessons learned, common pitfalls, and their solutions
4
+ **Use:** Before implementing features or debugging issues
5
+ **Size:** ~15k tokens (grows over time)
6
+ **Last Updated:** {{DATE}}
7
+
8
+ ---
9
+
10
+ ## How to Use This File
11
+
12
+ 1. **Before implementing:** Search for related gotchas
13
+ 2. **After fixing bugs:** Add new gotchas
14
+ 3. **During code review:** Reference relevant gotchas
15
+ 4. **Quarterly:** Review and archive resolved gotchas
16
+
17
+ ---
18
+
19
+ ## Gotcha Categories
20
+
21
+ 1. [Database](#database-gotchas)
22
+ 2. [API](#api-gotchas)
23
+ 3. [Authentication](#authentication-gotchas)
24
+ 4. [External Services](#external-services-gotchas)
25
+ 5. [Testing](#testing-gotchas)
26
+ 6. [Deployment](#deployment-gotchas)
27
+
28
+ ---
29
+
30
+ ## Database Gotchas
31
+
32
+ ### GOTCHA-DB-001: {{GOTCHA_TITLE}}
33
+
34
+ **Severity:** CRITICAL / HIGH / MEDIUM / LOW
35
+ **Discovered:** {{DATE}}
36
+ **Workflow Impact:** [workflow_1.md](./workflows/workflow_1.md)
37
+
38
+ **Symptom:**
39
+ {{WHAT_GOES_WRONG}}
40
+
41
+ **Root Cause:**
42
+ {{WHY_IT_HAPPENS}}
43
+
44
+ **Fix:**
45
+ ```
46
+ {{CODE_OR_STEPS_TO_FIX}}
47
+ ```
48
+
49
+ **Prevention:**
50
+ - {{HOW_TO_AVOID_IN_FUTURE}}
51
+
52
+ ---
53
+
54
+ ### GOTCHA-DB-002: {{GOTCHA_TITLE}}
55
+
56
+ [Same structure...]
57
+
58
+ ---
59
+
60
+ ## API Gotchas
61
+
62
+ ### GOTCHA-API-001: {{GOTCHA_TITLE}}
63
+
64
+ **Severity:** CRITICAL / HIGH / MEDIUM / LOW
65
+ **Discovered:** {{DATE}}
66
+ **Workflow Impact:** [workflow_2.md](./workflows/workflow_2.md)
67
+
68
+ **Symptom:**
69
+ {{WHAT_GOES_WRONG}}
70
+
71
+ **Root Cause:**
72
+ {{WHY_IT_HAPPENS}}
73
+
74
+ **Fix:**
75
+ ```
76
+ {{CODE_OR_STEPS_TO_FIX}}
77
+ ```
78
+
79
+ **Prevention:**
80
+ - {{HOW_TO_AVOID_IN_FUTURE}}
81
+
82
+ ---
83
+
84
+ ## Authentication Gotchas
85
+
86
+ ### GOTCHA-AUTH-001: {{GOTCHA_TITLE}}
87
+
88
+ [Same structure...]
89
+
90
+ ---
91
+
92
+ ## External Services Gotchas
93
+
94
+ ### GOTCHA-EXT-001: {{GOTCHA_TITLE}}
95
+
96
+ [Same structure...]
97
+
98
+ ---
99
+
100
+ ## Testing Gotchas
101
+
102
+ ### GOTCHA-TEST-001: {{GOTCHA_TITLE}}
103
+
104
+ [Same structure...]
105
+
106
+ ---
107
+
108
+ ## Deployment Gotchas
109
+
110
+ ### GOTCHA-DEPLOY-001: {{GOTCHA_TITLE}}
111
+
112
+ [Same structure...]
113
+
114
+ ---
115
+
116
+ ## Quick Reference Table
117
+
118
+ | ID | Title | Severity | Workflow |
119
+ |----|-------|----------|----------|
120
+ | DB-001 | {{TITLE}} | {{SEVERITY}} | workflow_1 |
121
+ | API-001 | {{TITLE}} | {{SEVERITY}} | workflow_2 |
122
+ | AUTH-001 | {{TITLE}} | {{SEVERITY}} | workflow_3 |
123
+
124
+ ---
125
+
126
+ ## Adding New Gotchas
127
+
128
+ ### Template
129
+
130
+ ```markdown
131
+ ### GOTCHA-[CATEGORY]-[NUMBER]: [Title]
132
+
133
+ **Severity:** CRITICAL / HIGH / MEDIUM / LOW
134
+ **Discovered:** YYYY-MM-DD
135
+ **Workflow Impact:** [workflow_name.md](./workflows/workflow_name.md)
136
+
137
+ **Symptom:**
138
+ [What the user/developer observes going wrong]
139
+
140
+ **Root Cause:**
141
+ [Technical explanation of why it happens]
142
+
143
+ **Fix:**
144
+ ```
145
+ [Code or steps to fix]
146
+ ```
147
+
148
+ **Prevention:**
149
+ - [How to avoid this in future code]
150
+ - [What patterns to use instead]
151
+ ```
152
+
153
+ ### Categories
154
+
155
+ - **DB**: Database, migrations, queries
156
+ - **API**: REST endpoints, request/response
157
+ - **AUTH**: Authentication, authorization, sessions
158
+ - **EXT**: External services, APIs, integrations
159
+ - **TEST**: Testing, mocking, fixtures
160
+ - **DEPLOY**: Deployment, CI/CD, infrastructure
161
+
162
+ ### Severity Levels
163
+
164
+ | Level | Definition |
165
+ |-------|------------|
166
+ | CRITICAL | Production down, data loss possible |
167
+ | HIGH | Feature broken, workaround difficult |
168
+ | MEDIUM | Feature degraded, workaround exists |
169
+ | LOW | Minor inconvenience, edge case |
170
+
171
+ ---
172
+
173
+ ## Archived Gotchas
174
+
175
+ Gotchas that are fully resolved and no longer relevant:
176
+
177
+ | ID | Title | Resolved Date | Resolution |
178
+ |----|-------|---------------|------------|
179
+ | - | - | - | - |
180
+
181
+ ---
182
+
183
+ ## Statistics
184
+
185
+ - **Total Active Gotchas:** {{TOTAL_COUNT}}
186
+ - **Critical:** {{CRITICAL_COUNT}}
187
+ - **High:** {{HIGH_COUNT}}
188
+ - **Medium:** {{MEDIUM_COUNT}}
189
+ - **Low:** {{LOW_COUNT}}
190
+ - **Last Added:** {{LAST_ADDED_DATE}}
191
+
192
+ ---
193
+
194
+ **Version:** 1.0
195
+ **Maintainer:** {{MAINTAINER}}