6.5 KiB
description, handoffs
| description | handoffs | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Execute the implementation planning workflow for ss-tools (Python backend + Svelte frontend) and generate research, design, contracts, and quickstart artifacts. |
|
User Input
$ARGUMENTS
You MUST consider the user input before proceeding (if not empty).
Outline
-
Setup: Run
.specify/scripts/bash/setup-plan.sh --jsonfrom repo root and parseFEATURE_SPEC,IMPL_PLAN,SPECS_DIR, andBRANCH.IMPL_PLANis the authoritative path forplan.mdinsidespecs/<feature>/.- Derive
FEATURE_DIRfromIMPL_PLANand write every planning artifact there. - Never treat
.kilo/plans/*as workflow output for/speckit.plan.
-
Load canonical planning context:
README.mdrequirements.txt(backend dependencies)frontend/package.json(frontend dependencies).specify/memory/constitution.md.opencode/skills/semantics-core/SKILL.md.opencode/skills/semantics-contracts/SKILL.md.opencode/skills/semantics-python/SKILL.md.opencode/skills/semantics-svelte/SKILL.md.opencode/skills/semantics-testing/SKILL.md.specify/templates/plan-template.md- relevant
docs/adr/*.md
-
Execute the planning workflow using the template structure:
- Fill
Technical Contextfor the current repository reality: Python 3.9+/FastAPI backend, SvelteKit 5/Tailwind frontend, PostgreSQL, Docker, semantic contracts, belief runtime. - Fill
Constitution Checkusing the local constitution. - ERROR if a blocking constitutional or semantic conflict is discovered and cannot be justified.
- Phase 0: generate
research.mdinFEATURE_DIR, resolving all material unknowns. - Phase 1: generate
data-model.md,contracts/modules.md, optional machine-readable contract artifacts, andquickstart.mdinFEATURE_DIR. - Materialize blocking ADR references and planning decisions inside the plan and downstream contracts.
- Run
.specify/scripts/bash/update-agent-context.sh kilocodeafter planning artifacts are written.
- Fill
-
Stop and report after planning artifacts are complete. Report branch,
plan.mdpath, generated artifacts, and blocking ADR/decision-memory outcomes.
Phase 0: Research
Research must resolve only implementation-shaping unknowns that matter for this repository, such as:
- module placement under
backend/src/orfrontend/src/ - API endpoint design (REST routes, WebSocket channels)
- database schema changes (SQLAlchemy models, migrations)
- Svelte component hierarchy and store topology
- async task orchestration patterns
- test strategy (pytest + vitest) and required fixture coverage
- belief runtime instrumentation for C4/C5 flows
- semantic validation boundaries and static verification workflow
Write research.md with concise sections:
- Decision
- Rationale
- Alternatives Considered
- Impact On Contracts / Tasks
Use [NEED_CONTEXT: target] instead of inventing relation targets, DTO names, or module boundaries that cannot be grounded in repo context.
Phase 1: Design, ADR Continuity, and Contracts
UX / Interaction Validation
Validate the proposed design against ux_reference.md as an interaction reference for operators, API callers, CLI/operator flows, result envelopes, warnings, recovery guidance, and (when applicable) browser-based UI flows.
If the planned architecture degrades the promised interaction model, deterministic recovery path, or context-budget behavior, stop and warn the user.
Data Model Output
Generate data-model.md for ss-tools domain entities such as:
- Pydantic request/response schemas
- SQLAlchemy models and relationships
- WebSocket message formats
- Task state transitions
- Git operation entities
- Plugin configuration schemas
- Frontend TypeScript types (when feature is fullstack)
Global ADR Continuity
Before task decomposition, planning must identify any repo-shaping decisions this feature depends on or extends:
- Python module layout and decomposition
- FastAPI route organization
- SvelteKit routing and component hierarchy
- belief-state runtime behavior (JSON structured logging / console markers)
- semantic comment-anchor rules
- payload/schema stability decisions
For each durable choice, ensure the plan references the relevant ADR and explicitly records accepted and rejected paths.
Contract Design Output
Generate contracts/modules.md as the primary design contract for implementation. Contracts must:
- use short semantic IDs
- classify each planned module/component with
@COMPLEXITY1-5 - use canonical relation syntax
@RELATION PREDICATE -> TARGET_ID - preserve accepted-path and rejected-path memory via
@RATIONALEand@REJECTEDwhere needed - describe Python modules, FastAPI routes, Svelte components, stores, and services instead of inventing MCP/backend layers
Complexity guidance for this repository:
- Complexity 1: anchors only (DTOs, simple Pydantic schemas)
- Complexity 2:
@PURPOSE(pure functions, utility helpers) - Complexity 3:
@PURPOSE,@RELATION(service modules, route handlers) - Complexity 4:
@PURPOSE,@RELATION,@PRE,@POST,@SIDE_EFFECT; orchestration paths should account for belief runtime markers before mutation or return - Complexity 5: level 4 plus
@DATA_CONTRACT,@INVARIANT, and explicit decision-memory continuity
If a planned contract depends on unknown schema, relation target, or ADR identity, emit [NEED_CONTEXT: target] instead of fabricating placeholders.
Quickstart Output
Generate quickstart.md using real repository verification paths:
- Backend:
cd backend && source .venv/bin/activate && python -m pytest -v - Frontend:
cd frontend && npm run test - Lint:
python -m ruff check backend/src/ backend/tests/ - Docker:
docker compose up --build
Key Rules
- Use absolute paths in workflow execution.
- Planning must reflect the current repository structure (
backend/src/**/*.py,frontend/src/**/*.svelte,backend/tests/,docs/adr/*). - Do not reference
.ai/*or.kilocode/*paths (use.opencode/for skills). - Do not write any feature planning artifact outside
specs/<feature>/.... - Do not hand off to
speckit.tasksuntil blocking ADR continuity and rejected-path guardrails are explicit.