codex-genesis-harness 0.1.5 → 0.1.6
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/.codebase/ARCHITECTURE_REVIEW_COMPLETE.md +216 -216
- package/.codebase/CURRENT_STATE.md +7 -2
- package/.codebase/FILE_NAMING_CLARIFICATION.md +161 -161
- package/.codebase/HARNESS_COMPLETENESS_AUDIT.md +613 -613
- package/.codebase/IMPLEMENTATION_COMPLETE.md +429 -429
- package/.codebase/IMPLEMENTATION_HANDOFF.md +351 -351
- package/.codebase/IMPROVEMENTS_SUMMARY.md +419 -419
- package/.codebase/PHASE3_SKILLS_NAMING_COMPLETE.md +292 -292
- package/.codebase/PHASE_DEPENDENCY_MAP.md +486 -486
- package/.codebase/QUICK_START_SPEC_IMPACT.md +456 -456
- package/.codebase/README.md +139 -139
- package/.codebase/RECOVERY_POINTS.md +438 -438
- package/.codex/skills/genesis-api-sync/SKILL.md +354 -354
- package/.codex/skills/genesis-api-sync/checklists/api-sync-checklist.md +101 -101
- package/.codex/skills/genesis-api-sync/templates/api-change-template.md +257 -257
- package/.codex/skills/genesis-debug-guide/SKILL.md +479 -479
- package/.codex/skills/genesis-debug-guide/checklists/flaky-test-investigation.md +339 -339
- package/.codex/skills/genesis-debug-guide/checklists/production-bug-debug.md +210 -210
- package/.codex/skills/genesis-debug-guide/checklists/test-failure-debug.md +158 -158
- package/.codex/skills/genesis-debug-guide/observability/debug-commands.md +365 -365
- package/.codex/skills/genesis-debug-guide/playbooks/unit-test-failures.md +289 -289
- package/.codex/skills/genesis-debug-guide/templates/debug-investigation-log.md +288 -288
- package/.codex/skills/genesis-docs-automation/SKILL.md +1003 -1003
- package/.codex/skills/genesis-docs-automation/checklists/docs-validation.md +359 -359
- package/.codex/skills/genesis-docs-automation/checklists/spec-alignment.md +312 -312
- package/.codex/skills/genesis-docs-automation/observability/docs-tracking.md +382 -382
- package/.codex/skills/genesis-docs-automation/playbooks/auto-update-flow.md +851 -851
- package/.codex/skills/genesis-docs-automation/playbooks/changelog-generation.md +491 -491
- package/.codex/skills/genesis-docs-automation/templates/changelog-entry-template.md +187 -187
- package/.codex/skills/genesis-docs-automation/templates/handoff-template.md +297 -297
- package/.codex/skills/genesis-harness/SKILL.md +1427 -1427
- package/.codex/skills/genesis-harness/agents/openai.yaml +7 -7
- package/.codex/skills/genesis-harness/checklists/bug-fix-qa.md +169 -169
- package/.codex/skills/genesis-harness/checklists/new-feature-qa.md +157 -157
- package/.codex/skills/genesis-harness/checklists/refactor-qa.md +216 -216
- package/.codex/skills/genesis-harness/checklists/requirements-validation.md +211 -211
- package/.codex/skills/genesis-harness/references/planning-schema.md +35 -35
- package/.codex/skills/genesis-harness/references/quality-rubric.md +21 -21
- package/.codex/skills/genesis-harness/references/research-rubric.md +41 -41
- package/.codex/skills/genesis-harness/references/workflows.md +33 -33
- package/.codex/skills/genesis-harness/resources/agents-template.md +27 -27
- package/.codex/skills/genesis-harness/resources/api-docs-template.md +32 -32
- package/.codex/skills/genesis-harness/resources/architecture-template.md +30 -30
- package/.codex/skills/genesis-harness/resources/audit-template.md +26 -26
- package/.codex/skills/genesis-harness/resources/bug-template.md +34 -34
- package/.codex/skills/genesis-harness/resources/change-impact-matrix-template.md +204 -204
- package/.codex/skills/genesis-harness/resources/check-template.md +21 -21
- package/.codex/skills/genesis-harness/resources/conventions-template.md +42 -42
- package/.codex/skills/genesis-harness/resources/decision-template.md +33 -33
- package/.codex/skills/genesis-harness/resources/design-template.md +26 -26
- package/.codex/skills/genesis-harness/resources/escalation-template.md +21 -21
- package/.codex/skills/genesis-harness/resources/feature-template.md +49 -49
- package/.codex/skills/genesis-harness/resources/foundation-phase-template.md +131 -131
- package/.codex/skills/genesis-harness/resources/integrations-template.md +32 -32
- package/.codex/skills/genesis-harness/resources/journeys-template.md +13 -13
- package/.codex/skills/genesis-harness/resources/lessons-learned-template.md +12 -12
- package/.codex/skills/genesis-harness/resources/observability-template.md +34 -34
- package/.codex/skills/genesis-harness/resources/phase-00-foundation-template.md +76 -76
- package/.codex/skills/genesis-harness/resources/phase-template.md +34 -34
- package/.codex/skills/genesis-harness/resources/pitfalls-template.md +22 -22
- package/.codex/skills/genesis-harness/resources/planning-tree-template.md +39 -39
- package/.codex/skills/genesis-harness/resources/post-implementation-guide.md +347 -347
- package/.codex/skills/genesis-harness/resources/project-template.md +38 -38
- package/.codex/skills/genesis-harness/resources/quality-score-template.md +11 -11
- package/.codex/skills/genesis-harness/resources/requirements-template.md +26 -26
- package/.codex/skills/genesis-harness/resources/research-template.md +26 -26
- package/.codex/skills/genesis-harness/resources/review-template.md +22 -22
- package/.codex/skills/genesis-harness/resources/spec-changelog-template.md +6 -6
- package/.codex/skills/genesis-harness/resources/stack-template.md +33 -33
- package/.codex/skills/genesis-harness/resources/verification-template.md +26 -26
- package/.codex/skills/genesis-harness/scripts/check-architecture-boundaries.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/check-docs-sync.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/check-no-debug-logs.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/check-required-planning-files.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/check-spec-changelog.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/check-task-tracking.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/compact-context.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/create-adr.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/create-bug.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/create-feature.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/detect-stack.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/init-planning.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/list-changed-files.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/offload-log.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/run-verification.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/run-verify-loop.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/update-state.sh +0 -0
- package/.codex/skills/genesis-mvp-planning/SKILL.md +114 -0
- package/.codex/skills/genesis-mvp-planning/agents/openai.yaml +6 -0
- package/.codex/skills/genesis-mvp-planning/checklists/mvp-readiness.md +18 -0
- package/.codex/skills/genesis-mvp-planning/examples/5-phase-roadmap-example.md +43 -0
- package/.codex/skills/genesis-mvp-planning/templates/phase-1-core.md +17 -0
- package/.codex/skills/genesis-mvp-planning/templates/phase-2-auth.md +17 -0
- package/.codex/skills/genesis-mvp-planning/templates/phase-3-features.md +17 -0
- package/.codex/skills/genesis-mvp-planning/templates/phase-4-integrations.md +17 -0
- package/.codex/skills/genesis-mvp-planning/templates/phase-5-readiness.md +17 -0
- package/.codex/skills/genesis-new-design/agents/openai.yaml +3 -3
- package/.codex/skills/genesis-observability-automation/checklists/.gitkeep +0 -0
- package/.codex/skills/genesis-observability-automation/observability/.gitkeep +0 -0
- package/.codex/skills/genesis-observability-automation/playbooks/.gitkeep +0 -0
- package/.codex/skills/genesis-observability-automation/templates/.gitkeep +0 -0
- package/.codex/skills/genesis-release-orchestration/SKILL.md +653 -653
- package/.codex/skills/genesis-release-orchestration/checklists/post-deployment-verification.md +274 -274
- package/.codex/skills/genesis-release-orchestration/checklists/pre-release-validation.md +220 -220
- package/.codex/skills/genesis-release-orchestration/observability/release-tracking.md +253 -253
- package/.codex/skills/genesis-release-orchestration/playbooks/canary-deployment-orchestration.md +472 -472
- package/.codex/skills/genesis-release-orchestration/playbooks/semantic-versioning-automation.md +494 -494
- package/.codex/skills/genesis-release-orchestration/templates/deployment-strategy-template.md +303 -303
- package/.codex/skills/genesis-release-orchestration/templates/release-runbook-template.md +420 -420
- package/.codex/skills/genesis-research-first/SKILL.md +237 -237
- package/.codex/skills/genesis-research-first/templates/.gitkeep +0 -0
- package/.codex/skills/genesis-spec-propagation/SKILL.md +534 -534
- package/.codex/skills/genesis-spec-propagation/checklists/phase-update-verification.md +384 -384
- package/.codex/skills/genesis-spec-propagation/checklists/spec-change-detection.md +257 -257
- package/.codex/skills/genesis-spec-propagation/observability/propagation-tracking.md +373 -373
- package/.codex/skills/genesis-spec-propagation/playbooks/breaking-change-propagation.md +692 -692
- package/.codex/skills/genesis-spec-propagation/playbooks/feature-change-propagation.md +434 -434
- package/.codex/skills/genesis-spec-propagation/templates/migration-guide-template.md +407 -407
- package/.codex/skills/genesis-upgrade-design/agents/openai.yaml +3 -3
- package/.codex/skills/spec-impact-engine/SKILL.md +504 -504
- package/.codex/skills/spec-impact-engine/detect-spec-changes.sh +0 -0
- package/.codex-plugin/plugin.json +19 -19
- package/CHANGELOG.md +42 -0
- package/LICENSE +22 -22
- package/README.EN.md +784 -730
- package/README.VI.md +776 -723
- package/README.md +102 -247
- package/VERSION +2 -2
- package/bin/genesis-harness.js +90 -87
- package/package.json +9 -3
- package/scripts/README.md +342 -342
- package/scripts/compact-context.sh +0 -0
- package/scripts/contract_integrity_gate.js +83 -0
- package/scripts/detect-changes.sh +0 -0
- package/scripts/healing_telemetry.js +118 -0
- package/scripts/install.sh +4 -1
- package/scripts/offload-log.sh +0 -0
- package/scripts/prompt_sentinel.js +84 -0
- package/scripts/run-evals.sh +1 -0
- package/scripts/run-verify-loop.sh +11 -0
- package/scripts/spec_visual_sync.js +157 -0
- package/scripts/test_generator.js +142 -0
- package/scripts/transition_state.sh +0 -0
- package/scripts/uninstall.sh +1 -0
- package/scripts/validation_gates.sh +40 -1
- package/scripts/verify.sh +5 -0
- package/tests/unit/contract_integrity_gate.test.js +74 -0
- package/tests/unit/healing_telemetry.test.js +58 -0
- package/tests/unit/prompt_sentinel.test.js +50 -0
- package/tests/unit/spec_visual_sync.test.js +77 -0
- package/tests/unit/test_generator.test.js +62 -0
package/.codebase/README.md
CHANGED
|
@@ -1,139 +1,139 @@
|
|
|
1
|
-
# Repository Memory System
|
|
2
|
-
|
|
3
|
-
The `.codebase/` directory contains persistent, compressed documentation about the project state, architecture, and ongoing work. This is the **single source of truth** for understanding the codebase.
|
|
4
|
-
|
|
5
|
-
## Core Reference Files
|
|
6
|
-
|
|
7
|
-
### CURRENT_STATE.md
|
|
8
|
-
**What**: Snapshot of the project's current status
|
|
9
|
-
**Update**: After every significant change or phase completion
|
|
10
|
-
**When to read**: Before starting work to understand what's been done
|
|
11
|
-
|
|
12
|
-
### MODULE_INDEX.md
|
|
13
|
-
**What**: Complete inventory of all modules, skills, and components
|
|
14
|
-
**Update**: When adding/removing modules or significant restructures
|
|
15
|
-
**When to read**: To find where functionality lives
|
|
16
|
-
|
|
17
|
-
### TEST_MATRIX.md
|
|
18
|
-
**What**: Coverage status of all testable components
|
|
19
|
-
**Update**: After writing tests, every sprint
|
|
20
|
-
**When to read**: To identify testing gaps and priorities
|
|
21
|
-
|
|
22
|
-
### ARCHITECTURE.md
|
|
23
|
-
**What**: System design, data flow, and integration points
|
|
24
|
-
**Update**: When architecture decisions change
|
|
25
|
-
**When to read**: Before major refactoring or new features
|
|
26
|
-
|
|
27
|
-
### API_CONTRACTS.md
|
|
28
|
-
**What**: All API endpoints, schemas, and breaking changes
|
|
29
|
-
**Update**: When API changes (must update before implementation)
|
|
30
|
-
**When to read**: Before working on API features
|
|
31
|
-
|
|
32
|
-
### DOMAIN_MODELS.md
|
|
33
|
-
**What**: Core data structures and business logic rules
|
|
34
|
-
**Update**: When domain models evolve
|
|
35
|
-
**When to read**: To understand business constraints
|
|
36
|
-
|
|
37
|
-
### PIPELINE_FLOW.md
|
|
38
|
-
**What**: AI pipeline orchestration and data flow
|
|
39
|
-
**Update**: When pipeline configuration changes
|
|
40
|
-
**When to read**: To understand job execution order and dependencies
|
|
41
|
-
|
|
42
|
-
### DEPENDENCY_GRAPH.md
|
|
43
|
-
**What**: Module dependencies and relationships
|
|
44
|
-
**Update**: When adding new dependencies or removing unused ones
|
|
45
|
-
**When to read**: Before major refactoring to understand impact
|
|
46
|
-
|
|
47
|
-
### UI_ROUTES.md
|
|
48
|
-
**What**: Frontend routes, pages, and navigation flow
|
|
49
|
-
**Update**: When adding/removing pages or changing routes
|
|
50
|
-
**When to read**: To understand frontend structure
|
|
51
|
-
|
|
52
|
-
### EVOLUTION_PLAN.md
|
|
53
|
-
**What**: Future features, roadmap, and planned changes
|
|
54
|
-
**Update**: During planning phases
|
|
55
|
-
**When to read**: To align current work with long-term goals
|
|
56
|
-
|
|
57
|
-
### KNOWN_PROBLEMS.md
|
|
58
|
-
**What**: Active bugs, technical debt, and limitations
|
|
59
|
-
**Update**: When discovering or fixing issues
|
|
60
|
-
**When to read**: Before starting features (may need workarounds)
|
|
61
|
-
|
|
62
|
-
## Context Summaries
|
|
63
|
-
|
|
64
|
-
The `context/` subdirectory contains compressed summaries for quick reference:
|
|
65
|
-
|
|
66
|
-
- `backend-summary.md` - Backend services, APIs, databases
|
|
67
|
-
- `frontend-summary.md` - UI structure, routes, components
|
|
68
|
-
- `pipeline-summary.md` - Job orchestration and data flow
|
|
69
|
-
- `providers-summary.md` - External services and integrations
|
|
70
|
-
- `render-summary.md` - Rendering engines and output formats
|
|
71
|
-
- `tests-summary.md` - Test coverage and strategies
|
|
72
|
-
|
|
73
|
-
**These are read-only reference documents.** Update the source files, not these summaries.
|
|
74
|
-
|
|
75
|
-
## Maintenance Guidelines
|
|
76
|
-
|
|
77
|
-
### Before Starting Any Task
|
|
78
|
-
|
|
79
|
-
1. Read `CURRENT_STATE.md` - Understand what's been done
|
|
80
|
-
2. Read relevant reference files based on your work type
|
|
81
|
-
3. Check `KNOWN_PROBLEMS.md` - Avoid duplicating known issues
|
|
82
|
-
|
|
83
|
-
### After Completing Work
|
|
84
|
-
|
|
85
|
-
1. Update `CURRENT_STATE.md` with your changes
|
|
86
|
-
2. Update any reference files affected by your work
|
|
87
|
-
3. If you solved a known problem, remove from `KNOWN_PROBLEMS.md`
|
|
88
|
-
4. Create a decision log in `../observability/decision-logs/`
|
|
89
|
-
|
|
90
|
-
### Keeping Memory Fresh
|
|
91
|
-
|
|
92
|
-
- Do NOT let `.codebase/` files go stale
|
|
93
|
-
- If a file is >6 months old without updates, it's likely outdated
|
|
94
|
-
- Run `./scripts/verify.sh` to check consistency
|
|
95
|
-
- When in doubt, inspect actual code rather than trusting old docs
|
|
96
|
-
|
|
97
|
-
## File Size Expectations
|
|
98
|
-
|
|
99
|
-
- Each file should be **2000-5000 lines MAX**
|
|
100
|
-
- If a file grows larger, split into subtopics
|
|
101
|
-
- Use `context/` subdirectory for compressed summaries
|
|
102
|
-
- Link to specific sections, don't duplicate content
|
|
103
|
-
|
|
104
|
-
## Structure
|
|
105
|
-
|
|
106
|
-
```
|
|
107
|
-
.codebase/
|
|
108
|
-
├── README.md (this file)
|
|
109
|
-
├── CURRENT_STATE.md
|
|
110
|
-
├── MODULE_INDEX.md
|
|
111
|
-
├── TEST_MATRIX.md
|
|
112
|
-
├── ARCHITECTURE.md
|
|
113
|
-
├── API_CONTRACTS.md
|
|
114
|
-
├── DOMAIN_MODELS.md
|
|
115
|
-
├── PIPELINE_FLOW.md
|
|
116
|
-
├── DEPENDENCY_GRAPH.md
|
|
117
|
-
├── UI_ROUTES.md
|
|
118
|
-
├── EVOLUTION_PLAN.md
|
|
119
|
-
├── KNOWN_PROBLEMS.md
|
|
120
|
-
└── context/
|
|
121
|
-
├── backend-summary.md
|
|
122
|
-
├── frontend-summary.md
|
|
123
|
-
├── pipeline-summary.md
|
|
124
|
-
├── providers-summary.md
|
|
125
|
-
├── render-summary.md
|
|
126
|
-
└── tests-summary.md
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
## Quick Reference
|
|
130
|
-
|
|
131
|
-
| Task | Read First | Update After |
|
|
132
|
-
|------|-----------|--------------|
|
|
133
|
-
| New feature | CURRENT_STATE, EVOLUTION_PLAN | CURRENT_STATE, TEST_MATRIX |
|
|
134
|
-
| Bug fix | KNOWN_PROBLEMS, CURRENT_STATE | KNOWN_PROBLEMS, CURRENT_STATE |
|
|
135
|
-
| Refactoring | ARCHITECTURE, DEPENDENCY_GRAPH | ARCHITECTURE, DEPENDENCY_GRAPH |
|
|
136
|
-
| Testing | TEST_MATRIX | TEST_MATRIX, CURRENT_STATE |
|
|
137
|
-
| API work | API_CONTRACTS | API_CONTRACTS, CURRENT_STATE |
|
|
138
|
-
| Performance | PIPELINE_FLOW, DOMAIN_MODELS | CURRENT_STATE |
|
|
139
|
-
| Deployment | CURRENT_STATE, EVOLUTION_PLAN | CURRENT_STATE |
|
|
1
|
+
# Repository Memory System
|
|
2
|
+
|
|
3
|
+
The `.codebase/` directory contains persistent, compressed documentation about the project state, architecture, and ongoing work. This is the **single source of truth** for understanding the codebase.
|
|
4
|
+
|
|
5
|
+
## Core Reference Files
|
|
6
|
+
|
|
7
|
+
### CURRENT_STATE.md
|
|
8
|
+
**What**: Snapshot of the project's current status
|
|
9
|
+
**Update**: After every significant change or phase completion
|
|
10
|
+
**When to read**: Before starting work to understand what's been done
|
|
11
|
+
|
|
12
|
+
### MODULE_INDEX.md
|
|
13
|
+
**What**: Complete inventory of all modules, skills, and components
|
|
14
|
+
**Update**: When adding/removing modules or significant restructures
|
|
15
|
+
**When to read**: To find where functionality lives
|
|
16
|
+
|
|
17
|
+
### TEST_MATRIX.md
|
|
18
|
+
**What**: Coverage status of all testable components
|
|
19
|
+
**Update**: After writing tests, every sprint
|
|
20
|
+
**When to read**: To identify testing gaps and priorities
|
|
21
|
+
|
|
22
|
+
### ARCHITECTURE.md
|
|
23
|
+
**What**: System design, data flow, and integration points
|
|
24
|
+
**Update**: When architecture decisions change
|
|
25
|
+
**When to read**: Before major refactoring or new features
|
|
26
|
+
|
|
27
|
+
### API_CONTRACTS.md
|
|
28
|
+
**What**: All API endpoints, schemas, and breaking changes
|
|
29
|
+
**Update**: When API changes (must update before implementation)
|
|
30
|
+
**When to read**: Before working on API features
|
|
31
|
+
|
|
32
|
+
### DOMAIN_MODELS.md
|
|
33
|
+
**What**: Core data structures and business logic rules
|
|
34
|
+
**Update**: When domain models evolve
|
|
35
|
+
**When to read**: To understand business constraints
|
|
36
|
+
|
|
37
|
+
### PIPELINE_FLOW.md
|
|
38
|
+
**What**: AI pipeline orchestration and data flow
|
|
39
|
+
**Update**: When pipeline configuration changes
|
|
40
|
+
**When to read**: To understand job execution order and dependencies
|
|
41
|
+
|
|
42
|
+
### DEPENDENCY_GRAPH.md
|
|
43
|
+
**What**: Module dependencies and relationships
|
|
44
|
+
**Update**: When adding new dependencies or removing unused ones
|
|
45
|
+
**When to read**: Before major refactoring to understand impact
|
|
46
|
+
|
|
47
|
+
### UI_ROUTES.md
|
|
48
|
+
**What**: Frontend routes, pages, and navigation flow
|
|
49
|
+
**Update**: When adding/removing pages or changing routes
|
|
50
|
+
**When to read**: To understand frontend structure
|
|
51
|
+
|
|
52
|
+
### EVOLUTION_PLAN.md
|
|
53
|
+
**What**: Future features, roadmap, and planned changes
|
|
54
|
+
**Update**: During planning phases
|
|
55
|
+
**When to read**: To align current work with long-term goals
|
|
56
|
+
|
|
57
|
+
### KNOWN_PROBLEMS.md
|
|
58
|
+
**What**: Active bugs, technical debt, and limitations
|
|
59
|
+
**Update**: When discovering or fixing issues
|
|
60
|
+
**When to read**: Before starting features (may need workarounds)
|
|
61
|
+
|
|
62
|
+
## Context Summaries
|
|
63
|
+
|
|
64
|
+
The `context/` subdirectory contains compressed summaries for quick reference:
|
|
65
|
+
|
|
66
|
+
- `backend-summary.md` - Backend services, APIs, databases
|
|
67
|
+
- `frontend-summary.md` - UI structure, routes, components
|
|
68
|
+
- `pipeline-summary.md` - Job orchestration and data flow
|
|
69
|
+
- `providers-summary.md` - External services and integrations
|
|
70
|
+
- `render-summary.md` - Rendering engines and output formats
|
|
71
|
+
- `tests-summary.md` - Test coverage and strategies
|
|
72
|
+
|
|
73
|
+
**These are read-only reference documents.** Update the source files, not these summaries.
|
|
74
|
+
|
|
75
|
+
## Maintenance Guidelines
|
|
76
|
+
|
|
77
|
+
### Before Starting Any Task
|
|
78
|
+
|
|
79
|
+
1. Read `CURRENT_STATE.md` - Understand what's been done
|
|
80
|
+
2. Read relevant reference files based on your work type
|
|
81
|
+
3. Check `KNOWN_PROBLEMS.md` - Avoid duplicating known issues
|
|
82
|
+
|
|
83
|
+
### After Completing Work
|
|
84
|
+
|
|
85
|
+
1. Update `CURRENT_STATE.md` with your changes
|
|
86
|
+
2. Update any reference files affected by your work
|
|
87
|
+
3. If you solved a known problem, remove from `KNOWN_PROBLEMS.md`
|
|
88
|
+
4. Create a decision log in `../observability/decision-logs/`
|
|
89
|
+
|
|
90
|
+
### Keeping Memory Fresh
|
|
91
|
+
|
|
92
|
+
- Do NOT let `.codebase/` files go stale
|
|
93
|
+
- If a file is >6 months old without updates, it's likely outdated
|
|
94
|
+
- Run `./scripts/verify.sh` to check consistency
|
|
95
|
+
- When in doubt, inspect actual code rather than trusting old docs
|
|
96
|
+
|
|
97
|
+
## File Size Expectations
|
|
98
|
+
|
|
99
|
+
- Each file should be **2000-5000 lines MAX**
|
|
100
|
+
- If a file grows larger, split into subtopics
|
|
101
|
+
- Use `context/` subdirectory for compressed summaries
|
|
102
|
+
- Link to specific sections, don't duplicate content
|
|
103
|
+
|
|
104
|
+
## Structure
|
|
105
|
+
|
|
106
|
+
```
|
|
107
|
+
.codebase/
|
|
108
|
+
├── README.md (this file)
|
|
109
|
+
├── CURRENT_STATE.md
|
|
110
|
+
├── MODULE_INDEX.md
|
|
111
|
+
├── TEST_MATRIX.md
|
|
112
|
+
├── ARCHITECTURE.md
|
|
113
|
+
├── API_CONTRACTS.md
|
|
114
|
+
├── DOMAIN_MODELS.md
|
|
115
|
+
├── PIPELINE_FLOW.md
|
|
116
|
+
├── DEPENDENCY_GRAPH.md
|
|
117
|
+
├── UI_ROUTES.md
|
|
118
|
+
├── EVOLUTION_PLAN.md
|
|
119
|
+
├── KNOWN_PROBLEMS.md
|
|
120
|
+
└── context/
|
|
121
|
+
├── backend-summary.md
|
|
122
|
+
├── frontend-summary.md
|
|
123
|
+
├── pipeline-summary.md
|
|
124
|
+
├── providers-summary.md
|
|
125
|
+
├── render-summary.md
|
|
126
|
+
└── tests-summary.md
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
## Quick Reference
|
|
130
|
+
|
|
131
|
+
| Task | Read First | Update After |
|
|
132
|
+
|------|-----------|--------------|
|
|
133
|
+
| New feature | CURRENT_STATE, EVOLUTION_PLAN | CURRENT_STATE, TEST_MATRIX |
|
|
134
|
+
| Bug fix | KNOWN_PROBLEMS, CURRENT_STATE | KNOWN_PROBLEMS, CURRENT_STATE |
|
|
135
|
+
| Refactoring | ARCHITECTURE, DEPENDENCY_GRAPH | ARCHITECTURE, DEPENDENCY_GRAPH |
|
|
136
|
+
| Testing | TEST_MATRIX | TEST_MATRIX, CURRENT_STATE |
|
|
137
|
+
| API work | API_CONTRACTS | API_CONTRACTS, CURRENT_STATE |
|
|
138
|
+
| Performance | PIPELINE_FLOW, DOMAIN_MODELS | CURRENT_STATE |
|
|
139
|
+
| Deployment | CURRENT_STATE, EVOLUTION_PLAN | CURRENT_STATE |
|