103 lines
3.4 KiB
Markdown
103 lines
3.4 KiB
Markdown
# Implementation Plan: [FEATURE]
|
|
|
|
**Branch**: `[###-feature-name]` | **Date**: [DATE] | **Spec**: [link]
|
|
**Input**: Feature specification from `/specs/[###-feature-name]/spec.md`
|
|
|
|
**Note**: This template is filled in by the `/speckit.plan` command. See `.specify/templates/commands/plan.md` for the execution workflow.
|
|
|
|
## Summary
|
|
|
|
[Extract from feature spec: primary requirement + technical approach from research]
|
|
|
|
## Technical Context
|
|
|
|
**Language/Version**: Python 3.9+ (Backend), Node.js 18+ (Frontend)
|
|
**Primary Dependencies**: FastAPI, SvelteKit, Tailwind CSS
|
|
**Storage**: N/A (Superset API integration)
|
|
**Testing**: pytest (Backend), vitest (Frontend)
|
|
**Target Platform**: Web Browser, Linux Server
|
|
**Project Type**: Web application
|
|
**Performance Goals**: Filtering < 200ms
|
|
**Constraints**: Pagination for large datasets
|
|
**Scale/Scope**: < 1000 dashboards typical
|
|
|
|
## Constitution Check
|
|
|
|
*GATE: Must pass before Phase 0 research. Re-check after Phase 1 design.*
|
|
|
|
- [x] **I. Causal Validity**: Contracts (`data-model.md`, `contracts/api.md`) defined before implementation.
|
|
- [x] **II. Immutability**: No core architecture changes.
|
|
- [x] **III. Semantic Format**: `[DEF]` syntax used in contracts.
|
|
- [x] **IV. DbC**: Pre/Post conditions defined in contracts.
|
|
- [x] **V. Belief State**: Logging standards acknowledged.
|
|
|
|
## Project Structure
|
|
|
|
### Documentation (this feature)
|
|
|
|
```text
|
|
specs/[###-feature]/
|
|
├── plan.md # This file (/speckit.plan command output)
|
|
├── research.md # Phase 0 output (/speckit.plan command)
|
|
├── data-model.md # Phase 1 output (/speckit.plan command)
|
|
├── quickstart.md # Phase 1 output (/speckit.plan command)
|
|
├── contracts/ # Phase 1 output (/speckit.plan command)
|
|
└── tasks.md # Phase 2 output (/speckit.tasks command - NOT created by /speckit.plan)
|
|
```
|
|
|
|
### Source Code (repository root)
|
|
<!--
|
|
ACTION REQUIRED: Replace the placeholder tree below with the concrete layout
|
|
for this feature. Delete unused options and expand the chosen structure with
|
|
real paths (e.g., apps/admin, packages/something). The delivered plan must
|
|
not include Option labels.
|
|
-->
|
|
|
|
```text
|
|
# [REMOVE IF UNUSED] Option 1: Single project (DEFAULT)
|
|
src/
|
|
├── models/
|
|
├── services/
|
|
├── cli/
|
|
└── lib/
|
|
|
|
tests/
|
|
├── contract/
|
|
├── integration/
|
|
└── unit/
|
|
|
|
# [REMOVE IF UNUSED] Option 2: Web application (when "frontend" + "backend" detected)
|
|
backend/
|
|
├── src/
|
|
│ ├── models/
|
|
│ ├── services/
|
|
│ └── api/
|
|
└── tests/
|
|
|
|
frontend/
|
|
├── src/
|
|
│ ├── components/
|
|
│ ├── pages/
|
|
│ └── services/
|
|
└── tests/
|
|
|
|
# [REMOVE IF UNUSED] Option 3: Mobile + API (when "iOS/Android" detected)
|
|
api/
|
|
└── [same as backend above]
|
|
|
|
ios/ or android/
|
|
└── [platform-specific structure: feature modules, UI flows, platform tests]
|
|
```
|
|
|
|
**Structure Decision**: [Document the selected structure and reference the real
|
|
directories captured above]
|
|
|
|
## Complexity Tracking
|
|
|
|
> **Fill ONLY if Constitution Check has violations that must be justified**
|
|
|
|
| Violation | Why Needed | Simpler Alternative Rejected Because |
|
|
|-----------|------------|-------------------------------------|
|
|
| [e.g., 4th project] | [current need] | [why 3 projects insufficient] |
|
|
| [e.g., Repository pattern] | [specific problem] | [why direct DB access insufficient] |
|