create-claude-context 1.0.0 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -21
- package/README.md +146 -146
- package/bin/create-claude-context.js +61 -61
- package/lib/detector.js +373 -373
- package/lib/index.js +170 -170
- package/lib/installer.js +371 -362
- package/lib/placeholder.js +208 -208
- package/lib/prompts.js +287 -287
- package/lib/spinner.js +60 -60
- package/lib/validate.js +147 -147
- package/package.json +59 -59
- package/templates/CLAUDE.md.template +235 -235
- package/templates/base/README.md +257 -257
- package/templates/base/RPI_WORKFLOW_PLAN.md +320 -320
- package/templates/base/agents/api-developer.md +76 -76
- package/templates/base/agents/context-engineer.md +525 -525
- package/templates/base/agents/core-architect.md +76 -76
- package/templates/base/agents/database-ops.md +76 -76
- package/templates/base/agents/deployment-ops.md +76 -76
- package/templates/base/agents/integration-hub.md +76 -76
- package/templates/base/analytics/README.md +114 -114
- package/templates/base/automation/config.json +58 -0
- package/templates/base/automation/generators/code-mapper.js +308 -0
- package/templates/base/automation/generators/index-builder.js +321 -0
- package/templates/base/automation/hooks/post-commit.sh +83 -0
- package/templates/base/automation/hooks/pre-commit.sh +103 -0
- package/templates/base/ci-templates/README.md +108 -108
- package/templates/base/ci-templates/github-actions/context-check.yml +144 -144
- package/templates/base/ci-templates/github-actions/validate-docs.yml +105 -105
- package/templates/base/commands/analytics.md +238 -238
- package/templates/base/commands/auto-sync.md +172 -0
- package/templates/base/commands/collab.md +194 -194
- package/templates/base/commands/help.md +450 -450
- package/templates/base/commands/rpi-implement.md +115 -115
- package/templates/base/commands/rpi-plan.md +93 -93
- package/templates/base/commands/rpi-research.md +88 -88
- package/templates/base/commands/session-resume.md +144 -0
- package/templates/base/commands/session-save.md +112 -0
- package/templates/base/commands/validate-all.md +77 -77
- package/templates/base/commands/verify-docs-current.md +86 -86
- package/templates/base/config/base.json +57 -57
- package/templates/base/config/environments/development.json +13 -13
- package/templates/base/config/environments/production.json +17 -17
- package/templates/base/config/environments/staging.json +13 -13
- package/templates/base/config/local.json.example +21 -21
- package/templates/base/context/.meta/generated-at.json +18 -0
- package/templates/base/context/ARCHITECTURE_SNAPSHOT.md +156 -156
- package/templates/base/context/CODE_TO_WORKFLOW_MAP.md +94 -94
- package/templates/base/context/FILE_OWNERSHIP.md +57 -0
- package/templates/base/context/INTEGRATION_POINTS.md +92 -0
- package/templates/base/context/KNOWN_GOTCHAS.md +195 -195
- package/templates/base/context/TESTING_MAP.md +95 -0
- package/templates/base/context/WORKFLOW_INDEX.md +129 -129
- package/templates/base/context/workflows/WORKFLOW_TEMPLATE.md +294 -294
- package/templates/base/indexes/agents/CAPABILITY_MATRIX.md +255 -255
- package/templates/base/indexes/agents/CATEGORY_INDEX.md +44 -44
- package/templates/base/indexes/code/CATEGORY_INDEX.md +38 -38
- package/templates/base/indexes/routing/CATEGORY_INDEX.md +39 -39
- package/templates/base/indexes/search/CATEGORY_INDEX.md +39 -39
- package/templates/base/indexes/workflows/CATEGORY_INDEX.md +38 -38
- package/templates/base/knowledge/README.md +98 -98
- package/templates/base/knowledge/sessions/README.md +88 -88
- package/templates/base/knowledge/sessions/TEMPLATE.md +150 -150
- package/templates/base/knowledge/shared/decisions/0001-adopt-context-engineering.md +144 -144
- package/templates/base/knowledge/shared/decisions/README.md +49 -49
- package/templates/base/knowledge/shared/decisions/TEMPLATE.md +123 -123
- package/templates/base/knowledge/shared/patterns/README.md +62 -62
- package/templates/base/knowledge/shared/patterns/TEMPLATE.md +120 -120
- package/templates/base/plans/PLAN_TEMPLATE.md +250 -250
- package/templates/base/research/RESEARCH_TEMPLATE.md +153 -153
- package/templates/base/schemas/agent.schema.json +141 -141
- package/templates/base/schemas/anchors.schema.json +54 -0
- package/templates/base/schemas/automation.schema.json +93 -0
- package/templates/base/schemas/command.schema.json +134 -134
- package/templates/base/schemas/hashes.schema.json +40 -0
- package/templates/base/schemas/manifest.schema.json +117 -117
- package/templates/base/schemas/plan.schema.json +136 -136
- package/templates/base/schemas/research.schema.json +115 -115
- package/templates/base/schemas/roles.schema.json +34 -0
- package/templates/base/schemas/session.schema.json +77 -0
- package/templates/base/schemas/settings.schema.json +244 -244
- package/templates/base/schemas/staleness.schema.json +53 -0
- package/templates/base/schemas/team-config.schema.json +42 -0
- package/templates/base/schemas/workflow.schema.json +126 -126
- package/templates/base/session/checkpoints/.gitkeep +2 -0
- package/templates/base/session/current/state.json +20 -0
- package/templates/base/session/history/.gitkeep +2 -0
- package/templates/base/settings.json +79 -57
- package/templates/base/standards/COMPATIBILITY.md +219 -219
- package/templates/base/standards/EXTENSION_GUIDELINES.md +280 -280
- package/templates/base/standards/QUALITY_CHECKLIST.md +211 -211
- package/templates/base/standards/README.md +66 -66
- package/templates/base/sync/anchors.json +6 -0
- package/templates/base/sync/hashes.json +6 -0
- package/templates/base/sync/staleness.json +10 -0
- package/templates/base/team/README.md +168 -168
- package/templates/base/team/config.json +79 -79
- package/templates/base/team/roles.json +145 -145
- package/templates/base/tools/bin/claude-context.js +151 -151
- package/templates/base/tools/lib/anchor-resolver.js +276 -0
- package/templates/base/tools/lib/config-loader.js +363 -363
- package/templates/base/tools/lib/detector.js +350 -350
- package/templates/base/tools/lib/diagnose.js +206 -206
- package/templates/base/tools/lib/drift-detector.js +373 -0
- package/templates/base/tools/lib/errors.js +199 -199
- package/templates/base/tools/lib/index.js +36 -24
- package/templates/base/tools/lib/init.js +192 -192
- package/templates/base/tools/lib/logger.js +230 -230
- package/templates/base/tools/lib/placeholder.js +201 -201
- package/templates/base/tools/lib/session-manager.js +354 -0
- package/templates/base/tools/lib/validate.js +521 -521
- package/templates/base/tools/package.json +49 -49
|
@@ -0,0 +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
|
+
| `.claude/` | {{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*
|
|
@@ -0,0 +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,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}}
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# Testing Map
|
|
2
|
+
|
|
3
|
+
> Maps source files to their corresponding tests.
|
|
4
|
+
> **Last Updated:** {{LAST_UPDATED}}
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Overview
|
|
9
|
+
|
|
10
|
+
This document provides a mapping between source files and their test coverage, helping developers find and update tests when modifying code.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Test Structure
|
|
15
|
+
|
|
16
|
+
```
|
|
17
|
+
tests/
|
|
18
|
+
├── unit/ # Unit tests
|
|
19
|
+
├── integration/ # Integration tests
|
|
20
|
+
├── e2e/ # End-to-end tests
|
|
21
|
+
└── fixtures/ # Test data and mocks
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## Coverage Summary
|
|
27
|
+
|
|
28
|
+
| Category | Files | Covered | Coverage |
|
|
29
|
+
|----------|-------|---------|----------|
|
|
30
|
+
| Unit | {{UNIT_COUNT}} | {{UNIT_COVERED}} | {{UNIT_PCT}}% |
|
|
31
|
+
| Integration | {{INT_COUNT}} | {{INT_COVERED}} | {{INT_PCT}}% |
|
|
32
|
+
| E2E | {{E2E_COUNT}} | {{E2E_COVERED}} | {{E2E_PCT}}% |
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## File-to-Test Mapping
|
|
37
|
+
|
|
38
|
+
### Core Application
|
|
39
|
+
|
|
40
|
+
| Source File | Test File | Coverage |
|
|
41
|
+
|-------------|-----------|----------|
|
|
42
|
+
| `src/{{file}}.{{ext}}` | `tests/unit/{{file}}.test.{{ext}}` | {{PCT}}% |
|
|
43
|
+
|
|
44
|
+
### Services
|
|
45
|
+
|
|
46
|
+
| Source File | Test File | Coverage |
|
|
47
|
+
|-------------|-----------|----------|
|
|
48
|
+
| `src/services/{{service}}.{{ext}}` | `tests/unit/services/{{service}}.test.{{ext}}` | {{PCT}}% |
|
|
49
|
+
|
|
50
|
+
### Utilities
|
|
51
|
+
|
|
52
|
+
| Source File | Test File | Coverage |
|
|
53
|
+
|-------------|-----------|----------|
|
|
54
|
+
| `src/utils/{{util}}.{{ext}}` | `tests/unit/utils/{{util}}.test.{{ext}}` | {{PCT}}% |
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## Critical Paths
|
|
59
|
+
|
|
60
|
+
These files require comprehensive test coverage:
|
|
61
|
+
|
|
62
|
+
| Path | Reason | Minimum Coverage |
|
|
63
|
+
|------|--------|------------------|
|
|
64
|
+
| `src/auth/` | Security-critical | 90% |
|
|
65
|
+
| `src/payment/` | Financial transactions | 95% |
|
|
66
|
+
| `src/api/` | Public interface | 85% |
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
## Test Commands
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
# Run all tests
|
|
74
|
+
{{TEST_COMMAND}}
|
|
75
|
+
|
|
76
|
+
# Run with coverage
|
|
77
|
+
{{COVERAGE_COMMAND}}
|
|
78
|
+
|
|
79
|
+
# Run specific test
|
|
80
|
+
{{SPECIFIC_TEST_COMMAND}}
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
## Maintenance
|
|
86
|
+
|
|
87
|
+
Update this file when:
|
|
88
|
+
- New source files are added
|
|
89
|
+
- New test files are created
|
|
90
|
+
- Coverage thresholds change
|
|
91
|
+
- Test structure changes
|
|
92
|
+
|
|
93
|
+
---
|
|
94
|
+
|
|
95
|
+
*Template file - populate with actual test coverage data*
|