codex-genesis-harness 0.1.0 → 0.1.1
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/API_CONTRACTS.md +12 -0
- package/.codebase/ARCHITECTURE.md +6 -0
- package/.codebase/CURRENT_STATE.md +6 -0
- package/.codebase/DEPENDENCY_GRAPH.md +14 -0
- package/.codebase/DOMAIN_MODELS.md +8 -0
- package/.codebase/EVOLUTION_PLAN.md +35 -0
- package/.codebase/KNOWN_PROBLEMS.md +6 -0
- package/.codebase/MODULE_INDEX.md +13 -0
- package/.codebase/PIPELINE_FLOW.md +14 -0
- package/.codebase/TEST_MATRIX.md +11 -0
- package/.codebase/UI_ROUTES.md +4 -0
- package/.codebase/context/backend-summary.md +4 -0
- package/.codebase/context/frontend-summary.md +4 -0
- package/.codebase/context/pipeline-summary.md +4 -0
- package/.codebase/context/providers-summary.md +4 -0
- package/.codebase/context/render-summary.md +4 -0
- package/.codebase/context/tests-summary.md +4 -0
- package/.codex/skills/ai-provider-skill/SKILL.md +46 -0
- package/.codex/skills/ai-provider-skill/agents/openai.yaml +7 -0
- package/.codex/skills/ai-provider-skill/checklists/checklist.md +9 -0
- package/.codex/skills/ai-provider-skill/examples/example.md +4 -0
- package/.codex/skills/ai-provider-skill/templates/provider-contract-template.md +9 -0
- package/.codex/skills/api-contract-skill/SKILL.md +46 -0
- package/.codex/skills/api-contract-skill/agents/openai.yaml +7 -0
- package/.codex/skills/api-contract-skill/checklists/checklist.md +8 -0
- package/.codex/skills/api-contract-skill/examples/example.md +4 -0
- package/.codex/skills/api-contract-skill/templates/api-contract-template.md +4 -0
- package/.codex/skills/architecture-skill/SKILL.md +46 -0
- package/.codex/skills/architecture-skill/agents/openai.yaml +7 -0
- package/.codex/skills/architecture-skill/checklists/checklist.md +8 -0
- package/.codex/skills/architecture-skill/examples/example.md +4 -0
- package/.codex/skills/architecture-skill/templates/architecture-decision-template.md +14 -0
- package/.codex/skills/codebase-map-skill/SKILL.md +46 -0
- package/.codex/skills/codebase-map-skill/agents/openai.yaml +7 -0
- package/.codex/skills/codebase-map-skill/checklists/checklist.md +7 -0
- package/.codex/skills/codebase-map-skill/examples/example.md +4 -0
- package/.codex/skills/codebase-map-skill/templates/map-update-template.md +8 -0
- package/.codex/skills/design-spec-skill/SKILL.md +46 -0
- package/.codex/skills/design-spec-skill/agents/openai.yaml +7 -0
- package/.codex/skills/design-spec-skill/checklists/checklist.md +7 -0
- package/.codex/skills/design-spec-skill/examples/example.md +4 -0
- package/.codex/skills/design-spec-skill/templates/design-spec-template.md +9 -0
- package/.codex/skills/docs-skill/SKILL.md +46 -0
- package/.codex/skills/docs-skill/agents/openai.yaml +7 -0
- package/.codex/skills/docs-skill/checklists/checklist.md +7 -0
- package/.codex/skills/docs-skill/examples/example.md +4 -0
- package/.codex/skills/docs-skill/templates/docs-update-template.md +8 -0
- package/.codex/skills/{project-genesis-harness → genesis-harness}/SKILL.md +43 -4
- package/.codex/skills/genesis-harness/agents/openai.yaml +9 -0
- package/.codex/skills/genesis-harness/checklists/checklist.md +10 -0
- package/.codex/skills/genesis-harness/examples/example.md +4 -0
- package/.codex/skills/genesis-harness/templates/harness-workflow-template.md +10 -0
- package/.codex/skills/genesis-new-design/SKILL.md +95 -0
- package/.codex/skills/genesis-new-design/agents/openai.yaml +4 -0
- package/.codex/skills/genesis-new-design/checklists/checklist.md +8 -0
- package/.codex/skills/genesis-new-design/examples/example.md +4 -0
- package/.codex/skills/genesis-new-design/templates/new-design-template.md +9 -0
- package/.codex/skills/genesis-upgrade-design/SKILL.md +97 -0
- package/.codex/skills/genesis-upgrade-design/agents/openai.yaml +4 -0
- package/.codex/skills/genesis-upgrade-design/checklists/checklist.md +8 -0
- package/.codex/skills/genesis-upgrade-design/examples/example.md +4 -0
- package/.codex/skills/genesis-upgrade-design/templates/upgrade-design-template.md +9 -0
- package/.codex/skills/harness-engineering-skill/SKILL.md +45 -0
- package/.codex/skills/harness-engineering-skill/agents/openai.yaml +7 -0
- package/.codex/skills/harness-engineering-skill/checklists/checklist.md +8 -0
- package/.codex/skills/harness-engineering-skill/examples/example.md +4 -0
- package/.codex/skills/harness-engineering-skill/templates/harness-change-template.md +8 -0
- package/.codex/skills/pipeline-orchestration-skill/SKILL.md +46 -0
- package/.codex/skills/pipeline-orchestration-skill/agents/openai.yaml +7 -0
- package/.codex/skills/pipeline-orchestration-skill/checklists/checklist.md +12 -0
- package/.codex/skills/pipeline-orchestration-skill/examples/example.md +4 -0
- package/.codex/skills/pipeline-orchestration-skill/templates/orchestration-template.md +12 -0
- package/.codex/skills/planning-skill/SKILL.md +46 -0
- package/.codex/skills/planning-skill/agents/openai.yaml +7 -0
- package/.codex/skills/planning-skill/checklists/checklist.md +8 -0
- package/.codex/skills/planning-skill/examples/example.md +4 -0
- package/.codex/skills/planning-skill/templates/plan-template.md +11 -0
- package/.codex/skills/release-skill/SKILL.md +46 -0
- package/.codex/skills/release-skill/agents/openai.yaml +7 -0
- package/.codex/skills/release-skill/checklists/checklist.md +8 -0
- package/.codex/skills/release-skill/examples/example.md +4 -0
- package/.codex/skills/release-skill/templates/release-checklist-template.md +9 -0
- package/.codex/skills/research-skill/SKILL.md +46 -0
- package/.codex/skills/research-skill/agents/openai.yaml +7 -0
- package/.codex/skills/research-skill/checklists/checklist.md +7 -0
- package/.codex/skills/research-skill/examples/example.md +4 -0
- package/.codex/skills/research-skill/templates/research-note-template.md +9 -0
- package/.codex/skills/ui-ux-test-skill/SKILL.md +46 -0
- package/.codex/skills/ui-ux-test-skill/agents/openai.yaml +7 -0
- package/.codex/skills/ui-ux-test-skill/checklists/checklist.md +8 -0
- package/.codex/skills/ui-ux-test-skill/examples/example.md +4 -0
- package/.codex/skills/ui-ux-test-skill/templates/playwright-test-template.md +4 -0
- package/.codex-plugin/plugin.json +13 -11
- package/README.md +164 -181
- package/bin/genesis-harness.js +124 -79
- package/contracts/agents/CharacterBibleAgent/error.json +1 -0
- package/contracts/agents/CharacterBibleAgent/example.json +1 -0
- package/contracts/agents/CharacterBibleAgent/request.json +1 -0
- package/contracts/agents/CharacterBibleAgent/response.json +1 -0
- package/contracts/agents/CharacterBibleAgent/schema.json +1 -0
- package/contracts/agents/ImageGenerationAgent/error.json +1 -0
- package/contracts/agents/ImageGenerationAgent/example.json +1 -0
- package/contracts/agents/ImageGenerationAgent/request.json +1 -0
- package/contracts/agents/ImageGenerationAgent/response.json +1 -0
- package/contracts/agents/ImageGenerationAgent/schema.json +1 -0
- package/contracts/agents/PipelineOrchestrator/error.json +1 -0
- package/contracts/agents/PipelineOrchestrator/example.json +1 -0
- package/contracts/agents/PipelineOrchestrator/request.json +1 -0
- package/contracts/agents/PipelineOrchestrator/response.json +1 -0
- package/contracts/agents/PipelineOrchestrator/schema.json +1 -0
- package/contracts/agents/PromptGenerationAgent/error.json +1 -0
- package/contracts/agents/PromptGenerationAgent/example.json +1 -0
- package/contracts/agents/PromptGenerationAgent/request.json +1 -0
- package/contracts/agents/PromptGenerationAgent/response.json +1 -0
- package/contracts/agents/PromptGenerationAgent/schema.json +1 -0
- package/contracts/agents/RenderAgent/error.json +1 -0
- package/contracts/agents/RenderAgent/example.json +1 -0
- package/contracts/agents/RenderAgent/request.json +1 -0
- package/contracts/agents/RenderAgent/response.json +1 -0
- package/contracts/agents/RenderAgent/schema.json +1 -0
- package/contracts/agents/ScenePlanningAgent/error.json +1 -0
- package/contracts/agents/ScenePlanningAgent/example.json +1 -0
- package/contracts/agents/ScenePlanningAgent/request.json +1 -0
- package/contracts/agents/ScenePlanningAgent/response.json +1 -0
- package/contracts/agents/ScenePlanningAgent/schema.json +1 -0
- package/contracts/agents/ScreenplayAgent/error.json +1 -0
- package/contracts/agents/ScreenplayAgent/example.json +1 -0
- package/contracts/agents/ScreenplayAgent/request.json +1 -0
- package/contracts/agents/ScreenplayAgent/response.json +1 -0
- package/contracts/agents/ScreenplayAgent/schema.json +1 -0
- package/contracts/agents/StoryAnalysisAgent/error.json +1 -0
- package/contracts/agents/StoryAnalysisAgent/example.json +1 -0
- package/contracts/agents/StoryAnalysisAgent/request.json +1 -0
- package/contracts/agents/StoryAnalysisAgent/response.json +1 -0
- package/contracts/agents/StoryAnalysisAgent/schema.json +1 -0
- package/contracts/agents/SubtitleGenerationAgent/error.json +1 -0
- package/contracts/agents/SubtitleGenerationAgent/example.json +1 -0
- package/contracts/agents/SubtitleGenerationAgent/request.json +1 -0
- package/contracts/agents/SubtitleGenerationAgent/response.json +1 -0
- package/contracts/agents/SubtitleGenerationAgent/schema.json +1 -0
- package/contracts/agents/VoiceGenerationAgent/error.json +1 -0
- package/contracts/agents/VoiceGenerationAgent/example.json +1 -0
- package/contracts/agents/VoiceGenerationAgent/request.json +1 -0
- package/contracts/agents/VoiceGenerationAgent/response.json +1 -0
- package/contracts/agents/VoiceGenerationAgent/schema.json +1 -0
- package/contracts/api/README.md +4 -0
- package/contracts/api/endpoint-template/error.json +7 -0
- package/contracts/api/endpoint-template/example.json +11 -0
- package/contracts/api/endpoint-template/request.json +7 -0
- package/contracts/api/endpoint-template/response.json +6 -0
- package/contracts/api/endpoint-template/schema.json +9 -0
- package/contracts/events/README.md +4 -0
- package/contracts/events/event-template/error.json +4 -0
- package/contracts/events/event-template/example.json +6 -0
- package/contracts/events/event-template/request.json +6 -0
- package/contracts/events/event-template/response.json +3 -0
- package/contracts/events/event-template/schema.json +8 -0
- package/contracts/ui/README.md +4 -0
- package/contracts/ui/screen-template/error.json +4 -0
- package/contracts/ui/screen-template/example.json +7 -0
- package/contracts/ui/screen-template/request.json +4 -0
- package/contracts/ui/screen-template/response.json +4 -0
- package/contracts/ui/screen-template/schema.json +8 -0
- package/fixtures/agents/agent-fixture-template.md +14 -0
- package/fixtures/api/api-fixture-template.md +14 -0
- package/fixtures/images/image-fixture-template.md +14 -0
- package/fixtures/pipeline/pipeline-fixture-template.md +14 -0
- package/fixtures/render/render-fixture-template.md +14 -0
- package/fixtures/tts/tts-fixture-template.md +14 -0
- package/fixtures/videos/video-fixture-template.md +14 -0
- package/observability/agent-runs/agent-run-template.md +22 -0
- package/observability/decision-logs/decision-log-template.md +18 -0
- package/observability/failures/failure-template.md +18 -0
- package/package.json +8 -2
- package/playwright/e2e/e2e-template.md +4 -0
- package/playwright/fixtures/ui-fixture-template.md +4 -0
- package/playwright/smoke/smoke-template.md +4 -0
- package/playwright/visual/visual-regression-template.md +4 -0
- package/scripts/install.sh +64 -39
- package/scripts/run-evals.sh +61 -22
- package/scripts/uninstall.sh +40 -20
- package/scripts/verify.sh +234 -55
- package/tests/contracts/contract-template.test.md +10 -0
- package/tests/fixtures/fixture-index.md +4 -0
- package/tests/integration/integration-template.test.md +4 -0
- package/tests/unit/unit-template.test.md +4 -0
- package/.codex/skills/project-genesis-harness/agents/openai.yaml +0 -9
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/references/planning-schema.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/references/quality-rubric.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/references/research-rubric.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/references/workflows.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/agents-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/api-docs-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/architecture-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/audit-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/bug-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/check-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/conventions-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/decision-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/design-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/escalation-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/feature-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/integrations-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/journeys-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/lessons-learned-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/observability-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/phase-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/pitfalls-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/planning-tree-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/project-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/quality-score-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/requirements-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/research-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/review-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/spec-changelog-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/stack-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/resources/verification-template.md +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/scripts/check-architecture-boundaries.sh +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/scripts/check-docs-sync.sh +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/scripts/check-no-debug-logs.sh +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/scripts/check-required-planning-files.sh +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/scripts/check-spec-changelog.sh +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/scripts/check-task-tracking.sh +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/scripts/create-adr.sh +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/scripts/create-bug.sh +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/scripts/create-feature.sh +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/scripts/detect-stack.sh +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/scripts/init-planning.sh +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/scripts/list-changed-files.sh +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/scripts/run-verification.sh +0 -0
- /package/.codex/skills/{project-genesis-harness → genesis-harness}/scripts/update-state.sh +0 -0
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# API Contracts
|
|
2
|
+
|
|
3
|
+
Contracts live under `contracts/`.
|
|
4
|
+
|
|
5
|
+
Required convention:
|
|
6
|
+
|
|
7
|
+
- `request.json`: accepted input shape.
|
|
8
|
+
- `response.json`: successful output shape.
|
|
9
|
+
- `schema.json`: validation schema.
|
|
10
|
+
- `example.json`: realistic example.
|
|
11
|
+
- `error.json`: failure response shape when applicable.
|
|
12
|
+
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
# Architecture
|
|
2
|
+
|
|
3
|
+
This repository packages a Codex harness skill system. The npm package installs skills from `.codex/skills/`, command wrappers from `bin/`, and validation scripts from `scripts/`.
|
|
4
|
+
|
|
5
|
+
Core boundary: skills define agent workflows; scripts validate and install them; repository memory under `.codebase/` compresses current knowledge for future sessions.
|
|
6
|
+
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
# Current State
|
|
2
|
+
|
|
3
|
+
Current objective: evolve `codex-genesis-harness` into a reusable Genesis skill set for test-first, contract-first, memory-aware Codex workflows.
|
|
4
|
+
|
|
5
|
+
Start every task by reading this file, `MODULE_INDEX.md`, and `TEST_MATRIX.md`, then inspect only relevant files.
|
|
6
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Dependency Graph
|
|
2
|
+
|
|
3
|
+
```mermaid
|
|
4
|
+
flowchart TD
|
|
5
|
+
npm["npm package"] --> cli["bin/genesis-harness.js"]
|
|
6
|
+
npm --> skills[".codex/skills"]
|
|
7
|
+
cli --> verify["scripts/verify.sh"]
|
|
8
|
+
cli --> install["scripts/install.sh"]
|
|
9
|
+
verify --> memory[".codebase"]
|
|
10
|
+
verify --> contracts["contracts"]
|
|
11
|
+
verify --> fixtures["fixtures"]
|
|
12
|
+
verify --> tests["tests and playwright"]
|
|
13
|
+
```
|
|
14
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# Domain Models
|
|
2
|
+
|
|
3
|
+
- Skill: a folder with `SKILL.md`, `agents/openai.yaml`, and optional templates, examples, checklists, scripts, references, or assets.
|
|
4
|
+
- Contract: versioned input/output/error/schema examples for APIs, agents, events, and UI surfaces.
|
|
5
|
+
- Fixture: reproducible input plus expected output and validation notes.
|
|
6
|
+
- Memory file: compressed repository knowledge updated after meaningful changes.
|
|
7
|
+
- Run log: observability record for autonomous modifications.
|
|
8
|
+
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Evolution Plan
|
|
2
|
+
|
|
3
|
+
## Current Weaknesses Identified
|
|
4
|
+
|
|
5
|
+
- The repo started with a small skill set and limited harness-wide specialization.
|
|
6
|
+
- Repository memory was absent, so future sessions had to rediscover structure.
|
|
7
|
+
- Contracts, fixtures, Playwright templates, and observability templates were not first-class package artifacts.
|
|
8
|
+
- Verification did not enforce memory, contracts, fixtures, or skill protocol consistency.
|
|
9
|
+
- Installer scripts knew only the initial Genesis skills.
|
|
10
|
+
|
|
11
|
+
## Target Architecture
|
|
12
|
+
|
|
13
|
+
- Skills are modular under `.codex/skills/`.
|
|
14
|
+
- Memory is compressed under `.codebase/` and `.codebase/context/`.
|
|
15
|
+
- Contracts live under `contracts/`.
|
|
16
|
+
- Fixtures live under `fixtures/`.
|
|
17
|
+
- Harness tests live under `tests/` and `playwright/`.
|
|
18
|
+
- Autonomous run evidence lives under `observability/`.
|
|
19
|
+
|
|
20
|
+
## Implementation Sequence
|
|
21
|
+
|
|
22
|
+
1. Add failing verification for required harness artifacts.
|
|
23
|
+
2. Create memory, contracts, fixtures, tests, Playwright, and observability templates.
|
|
24
|
+
3. Add modular skills with `SKILL.md`, `templates/`, `examples/`, and `checklists/`.
|
|
25
|
+
4. Update installer and package metadata to include all artifacts.
|
|
26
|
+
5. Update AGENTS and README as maps, not manuals.
|
|
27
|
+
6. Run verify, evals, skill validation, CLI smoke tests, and package dry-run.
|
|
28
|
+
|
|
29
|
+
## Next Hardening Pass
|
|
30
|
+
|
|
31
|
+
- Add machine-readable schema validation for contract JSON.
|
|
32
|
+
- Add snapshot tests for package tarball file lists.
|
|
33
|
+
- Add a release checklist that blocks publish when ignored generated files are tracked.
|
|
34
|
+
- Add forward-testing prompts for each skill against realistic downstream repositories.
|
|
35
|
+
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
# Known Problems
|
|
2
|
+
|
|
3
|
+
- `.npm-cache/` was previously committed by mistake; it is now ignored but may still exist in history.
|
|
4
|
+
- The current package provides templates and verification scaffolds, not application-specific generated tests.
|
|
5
|
+
- Downstream projects must fill concrete endpoint, UI, provider, and persistence details.
|
|
6
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Module Index
|
|
2
|
+
|
|
3
|
+
- `.codex/skills/`: packaged Codex skills.
|
|
4
|
+
- `bin/genesis-harness.js`: npm CLI for install, verify, uninstall, and path output.
|
|
5
|
+
- `scripts/verify.sh`: structural and smoke verification.
|
|
6
|
+
- `scripts/run-evals.sh`: package-level regression checks.
|
|
7
|
+
- `.codebase/`: compressed repository memory.
|
|
8
|
+
- `contracts/`: API, agent, event, and UI contract templates.
|
|
9
|
+
- `fixtures/`: reusable test and validation fixtures.
|
|
10
|
+
- `tests/`: harness test architecture templates.
|
|
11
|
+
- `playwright/`: UI smoke, e2e, and visual harness templates.
|
|
12
|
+
- `observability/`: autonomous run and decision logging templates.
|
|
13
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Pipeline Flow
|
|
2
|
+
|
|
3
|
+
```mermaid
|
|
4
|
+
flowchart LR
|
|
5
|
+
state["Read .codebase state"] --> test["Create failing test"]
|
|
6
|
+
test --> fixture["Create fixture and expected output"]
|
|
7
|
+
fixture --> impl["Implement minimum change"]
|
|
8
|
+
impl --> verify["Run verification"]
|
|
9
|
+
verify --> contracts["Update contracts"]
|
|
10
|
+
contracts --> memory["Update .codebase memory"]
|
|
11
|
+
memory --> docs["Update docs"]
|
|
12
|
+
docs --> summary["Write change summary"]
|
|
13
|
+
```
|
|
14
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Test Matrix
|
|
2
|
+
|
|
3
|
+
Required checks:
|
|
4
|
+
|
|
5
|
+
- `scripts/verify.sh`: repository harness structure, skill metadata, contracts, fixtures, and harness smoke test.
|
|
6
|
+
- `scripts/run-evals.sh`: install/verify/uninstall regression checks.
|
|
7
|
+
- `npm run pack:check`: package contents dry-run.
|
|
8
|
+
- Skill validation: run `quick_validate.py` for changed skills when available.
|
|
9
|
+
|
|
10
|
+
Feature rule: add or update fixtures and expected output before implementation.
|
|
11
|
+
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: ai-provider-skill
|
|
3
|
+
description: Define reliable AI provider harnesses with mock providers, schemas, retries, invalid JSON recovery, persistence tests, and provider contracts. Use for LLM, image, voice, subtitle, render, and pipeline provider work.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# AI Provider Skill
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
Make AI provider behavior deterministic under tests and recoverable under failures.
|
|
10
|
+
|
|
11
|
+
## When to use
|
|
12
|
+
Use before adding or changing AI providers, provider adapters, retry logic, schema parsing, or persistence.
|
|
13
|
+
|
|
14
|
+
## When NOT to use
|
|
15
|
+
Do not use for purely static documentation changes.
|
|
16
|
+
|
|
17
|
+
## Inputs required
|
|
18
|
+
Provider name, request shape, expected response, error modes, retry policy, and persistence target.
|
|
19
|
+
|
|
20
|
+
## Outputs required
|
|
21
|
+
Provider contract, mock provider fixture, schema validation, retry test, invalid JSON recovery test, and persistence test.
|
|
22
|
+
|
|
23
|
+
## Required tests
|
|
24
|
+
Mock success, provider error, retry, invalid JSON recovery, and persistence tests.
|
|
25
|
+
|
|
26
|
+
## Required fixtures
|
|
27
|
+
Create provider fixtures under `fixtures/agents`, `fixtures/images`, `fixtures/tts`, or related directories.
|
|
28
|
+
|
|
29
|
+
## Required contract updates
|
|
30
|
+
Update `contracts/agents/` or provider-specific contracts.
|
|
31
|
+
|
|
32
|
+
## Required codebase map updates
|
|
33
|
+
Update providers summary, pipeline flow, and test matrix.
|
|
34
|
+
|
|
35
|
+
## Token saving rules
|
|
36
|
+
Read provider summary and contract before provider code.
|
|
37
|
+
|
|
38
|
+
## Acceptance criteria
|
|
39
|
+
Provider output is schema-validated and failure recovery is tested.
|
|
40
|
+
|
|
41
|
+
## Common mistakes
|
|
42
|
+
Trusting raw model JSON, skipping retry tests, and using live provider calls in normal tests.
|
|
43
|
+
|
|
44
|
+
## Recovery workflow
|
|
45
|
+
If provider output is invalid, capture fixture, add parser recovery test, then patch parser or contract.
|
|
46
|
+
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: api-contract-skill
|
|
3
|
+
description: Create and verify API contracts before endpoint implementation. Use for API routes, service interfaces, validation rules, error shapes, snapshots, and endpoint tests.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# API Contract Skill
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
Ensure API behavior is defined by contracts, fixtures, and tests before code.
|
|
10
|
+
|
|
11
|
+
## When to use
|
|
12
|
+
Use before adding or changing endpoints, request schemas, response schemas, auth, errors, or persistence behavior.
|
|
13
|
+
|
|
14
|
+
## When NOT to use
|
|
15
|
+
Do not use for UI-only changes that do not touch API behavior.
|
|
16
|
+
|
|
17
|
+
## Inputs required
|
|
18
|
+
Endpoint path, method, auth, request body, success response, error cases, and persistence effects.
|
|
19
|
+
|
|
20
|
+
## Outputs required
|
|
21
|
+
Contract folder, fixture, success test, validation error test, not found test, and schema validation.
|
|
22
|
+
|
|
23
|
+
## Required tests
|
|
24
|
+
Create contract, integration, and unit tests as appropriate.
|
|
25
|
+
|
|
26
|
+
## Required fixtures
|
|
27
|
+
Create API fixtures for success and failure cases.
|
|
28
|
+
|
|
29
|
+
## Required contract updates
|
|
30
|
+
Update `contracts/api/` with request, response, schema, example, and error JSON.
|
|
31
|
+
|
|
32
|
+
## Required codebase map updates
|
|
33
|
+
Update `.codebase/API_CONTRACTS.md` and `TEST_MATRIX.md`.
|
|
34
|
+
|
|
35
|
+
## Token saving rules
|
|
36
|
+
Load endpoint contract before source files. Open only route and validator modules named by the contract.
|
|
37
|
+
|
|
38
|
+
## Acceptance criteria
|
|
39
|
+
Contract tests fail before implementation and pass after the minimum endpoint change.
|
|
40
|
+
|
|
41
|
+
## Common mistakes
|
|
42
|
+
Implementing validation before schema, changing error shape without a contract, and testing only success.
|
|
43
|
+
|
|
44
|
+
## Recovery workflow
|
|
45
|
+
If endpoint behavior is ambiguous, freeze implementation and create the missing contract first.
|
|
46
|
+
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: architecture-skill
|
|
3
|
+
description: Guide Codex through architecture analysis, boundary decisions, dependency direction, module ownership, and architecture documentation. Use before structural changes, new subsystems, cross-module work, or when architecture memory must be updated.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Architecture Skill
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
Maintain architecture as a verifiable contract between modules, tests, docs, and repository memory.
|
|
10
|
+
|
|
11
|
+
## When to use
|
|
12
|
+
Use before subsystem changes, dependency changes, major refactors, new services, or architecture decisions.
|
|
13
|
+
|
|
14
|
+
## When NOT to use
|
|
15
|
+
Do not use for copy-only edits or isolated single-file fixes with no boundary impact.
|
|
16
|
+
|
|
17
|
+
## Inputs required
|
|
18
|
+
Read `.codebase/CURRENT_STATE.md`, `.codebase/MODULE_INDEX.md`, `.codebase/TEST_MATRIX.md`, then inspect relevant architecture files only.
|
|
19
|
+
|
|
20
|
+
## Outputs required
|
|
21
|
+
Architecture decision, impacted modules, dependency changes, diagrams when useful, and `.codebase/ARCHITECTURE.md` updates.
|
|
22
|
+
|
|
23
|
+
## Required tests
|
|
24
|
+
Add or update tests proving module boundaries and dependency behavior.
|
|
25
|
+
|
|
26
|
+
## Required fixtures
|
|
27
|
+
Create fixtures for new boundary inputs, outputs, and failure modes.
|
|
28
|
+
|
|
29
|
+
## Required contract updates
|
|
30
|
+
Update contracts when public behavior or module interfaces change.
|
|
31
|
+
|
|
32
|
+
## Required codebase map updates
|
|
33
|
+
Update `ARCHITECTURE.md`, `MODULE_INDEX.md`, and `DEPENDENCY_GRAPH.md`.
|
|
34
|
+
|
|
35
|
+
## Token saving rules
|
|
36
|
+
Read maps first, then only modules named by the maps. Prefer diagrams and checklists over repeated prose.
|
|
37
|
+
|
|
38
|
+
## Acceptance criteria
|
|
39
|
+
Boundaries are explicit, tests pass, contracts match implementation, and memory is current.
|
|
40
|
+
|
|
41
|
+
## Common mistakes
|
|
42
|
+
Changing dependency direction silently, documenting intent without tests, and scanning the whole repo before reading memory.
|
|
43
|
+
|
|
44
|
+
## Recovery workflow
|
|
45
|
+
If architecture drift is found, stop feature work, create a failing boundary test, update the contract, then repair the smallest module slice.
|
|
46
|
+
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: codebase-map-skill
|
|
3
|
+
description: Maintain repository memory and compressed codebase maps for token-efficient Codex operation. Use when files move, modules change, contracts change, tests change, or repository summaries need updating.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Codebase Map Skill
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
Keep `.codebase/` accurate so future agents read summaries before source.
|
|
10
|
+
|
|
11
|
+
## When to use
|
|
12
|
+
Use after meaningful code, contract, test, route, provider, pipeline, or architecture changes.
|
|
13
|
+
|
|
14
|
+
## When NOT to use
|
|
15
|
+
Do not use for changes that do not affect repository understanding.
|
|
16
|
+
|
|
17
|
+
## Inputs required
|
|
18
|
+
Changed files, verification results, contracts touched, and current `.codebase` files.
|
|
19
|
+
|
|
20
|
+
## Outputs required
|
|
21
|
+
Updated module index, current state, test matrix, dependency graph, and context summaries.
|
|
22
|
+
|
|
23
|
+
## Required tests
|
|
24
|
+
Run `scripts/verify.sh` after memory updates.
|
|
25
|
+
|
|
26
|
+
## Required fixtures
|
|
27
|
+
Update fixture index when fixtures change.
|
|
28
|
+
|
|
29
|
+
## Required contract updates
|
|
30
|
+
Reflect changed contracts in `.codebase/API_CONTRACTS.md`.
|
|
31
|
+
|
|
32
|
+
## Required codebase map updates
|
|
33
|
+
Update all impacted `.codebase` files.
|
|
34
|
+
|
|
35
|
+
## Token saving rules
|
|
36
|
+
Summaries must be short, link to source locations, and avoid duplicating full manuals.
|
|
37
|
+
|
|
38
|
+
## Acceptance criteria
|
|
39
|
+
Future agents can orient by reading `CURRENT_STATE.md`, `MODULE_INDEX.md`, and `TEST_MATRIX.md`.
|
|
40
|
+
|
|
41
|
+
## Common mistakes
|
|
42
|
+
Letting memory drift, overloading summaries with full docs, and forgetting test matrix changes.
|
|
43
|
+
|
|
44
|
+
## Recovery workflow
|
|
45
|
+
If memory conflicts with code, trust verified code, update memory, and add a known problem entry.
|
|
46
|
+
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: design-spec-skill
|
|
3
|
+
description: Define UI design specs, route contracts, visual states, accessibility expectations, and UI/API synchronization before frontend implementation. Use for new screens, redesigns, visual QA, or UI contract updates.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Design Spec Skill
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
Make UI behavior and visual expectations contract-first before implementation.
|
|
10
|
+
|
|
11
|
+
## When to use
|
|
12
|
+
Use before creating or changing screens, dashboards, forms, flows, or visual states.
|
|
13
|
+
|
|
14
|
+
## When NOT to use
|
|
15
|
+
Do not use for backend-only changes with no UI effect.
|
|
16
|
+
|
|
17
|
+
## Inputs required
|
|
18
|
+
UI route, audience, state list, API dependencies, fixtures, and visual references if available.
|
|
19
|
+
|
|
20
|
+
## Outputs required
|
|
21
|
+
UI contract, Playwright fixture, acceptance states, and visual regression expectations.
|
|
22
|
+
|
|
23
|
+
## Required tests
|
|
24
|
+
Create load, interaction, validation, API sync, and visual regression tests where applicable.
|
|
25
|
+
|
|
26
|
+
## Required fixtures
|
|
27
|
+
Create UI fixtures for default, loading, empty, error, and success states.
|
|
28
|
+
|
|
29
|
+
## Required contract updates
|
|
30
|
+
Update `contracts/ui/` for changed routes or states.
|
|
31
|
+
|
|
32
|
+
## Required codebase map updates
|
|
33
|
+
Update `.codebase/UI_ROUTES.md` and frontend summary.
|
|
34
|
+
|
|
35
|
+
## Token saving rules
|
|
36
|
+
Use state tables and route maps instead of long visual prose.
|
|
37
|
+
|
|
38
|
+
## Acceptance criteria
|
|
39
|
+
The UI can be implemented and tested without guessing states or API behavior.
|
|
40
|
+
|
|
41
|
+
## Common mistakes
|
|
42
|
+
Designing only the happy path, skipping empty/error states, and omitting API synchronization.
|
|
43
|
+
|
|
44
|
+
## Recovery workflow
|
|
45
|
+
If implementation diverges from spec, update the failing UI test first, then repair contract or UI.
|
|
46
|
+
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: docs-skill
|
|
3
|
+
description: Keep Codex harness docs synchronized with skills, contracts, tests, memory, and release behavior. Use after any workflow, public interface, install, verification, or package behavior change.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Docs Skill
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
Keep docs short, accurate, and linked to source-of-truth artifacts.
|
|
10
|
+
|
|
11
|
+
## When to use
|
|
12
|
+
Use after changing skills, CLI behavior, contracts, fixtures, tests, repository memory, or publish flow.
|
|
13
|
+
|
|
14
|
+
## When NOT to use
|
|
15
|
+
Do not use to duplicate full architecture manuals in `AGENTS.md`.
|
|
16
|
+
|
|
17
|
+
## Inputs required
|
|
18
|
+
Changed files, public behavior, verification results, and affected users.
|
|
19
|
+
|
|
20
|
+
## Outputs required
|
|
21
|
+
Updated README, AGENTS map, codebase memory, changelog-style summary, and changed docs list.
|
|
22
|
+
|
|
23
|
+
## Required tests
|
|
24
|
+
Run docs-related verification and package dry-run when docs affect packaging or install instructions.
|
|
25
|
+
|
|
26
|
+
## Required fixtures
|
|
27
|
+
Update templates/examples when docs describe reusable workflows.
|
|
28
|
+
|
|
29
|
+
## Required contract updates
|
|
30
|
+
Update contracts when docs describe new interface behavior.
|
|
31
|
+
|
|
32
|
+
## Required codebase map updates
|
|
33
|
+
Update `.codebase/CURRENT_STATE.md`, `MODULE_INDEX.md`, or summaries as needed.
|
|
34
|
+
|
|
35
|
+
## Token saving rules
|
|
36
|
+
Keep docs concise. Link to templates and contracts instead of repeating them.
|
|
37
|
+
|
|
38
|
+
## Acceptance criteria
|
|
39
|
+
Docs match behavior and do not duplicate large internal manuals.
|
|
40
|
+
|
|
41
|
+
## Common mistakes
|
|
42
|
+
Letting AGENTS.md grow too large, documenting unverified behavior, and missing install docs.
|
|
43
|
+
|
|
44
|
+
## Recovery workflow
|
|
45
|
+
If docs drift, add verify assertions or checklist items that catch the drift next time.
|
|
46
|
+
|