Files
OSIT-AE-App-Svelte/documentation/GUIDE__Development.md
2026-03-17 13:20:26 -04:00

39 lines
2.4 KiB
Markdown

# Aether Development SOP (Frontend)
> **Version:** 1.1 (2026-02-16)
> **Location:** documentation/GUIDE__Development.md
## 1. 🛡️ Verification (The "Test-First" Mandate)
**Rule:** No code is to be committed unless it has passed local verification. Skipping this is a violation of the Aether Dev Protocol.
### Required Checks
1. **Svelte Integrity:** `npx svelte-check`
- **Zero Tolerance Policy:** If a task introduces even a single svelte-check warning or error, it must not be merged. All warnings must be resolved before code review or merge. This prevents the "circle-running" and technical debt that results from ignoring warnings.
2. **Type Safety:** Ensure interfaces in `src/lib/types/ae_types.ts` match backend schemas.
3. **Reactivity Check:** Verify Svelte 5 runes (`$state`, `$derived`) are not creating race conditions with Dexie `liveQuery`.
4. **Build Check:** For major changes, run `npm run build:staging` to ensure no SSR or build-time failures.
## 2. 📝 Commit & Sync Policy
- **Atomic Commits:** One component or one logic fix per commit. Do not batch unrelated changes.
- **Verification Log:** Mention the verification steps taken in your work log (`ae_log_work`).
- **Safety:** Use `~/tmp/gemini_trash` for removals; never use `rm` directly on source files.
## 3. 🤝 The Handshake (Coordination)
You are not working in a vacuum. You MUST coordinate with the Backend Agent.
### Mandatory Messaging Triggers
- **Data Requirements:** When a UI feature requires a new field or endpoint.
- **API Failures:** When a V3 endpoint returns unexpected data or 500s.
- **Status:** IGNORE THIS FOR NOW: ~~Update your shared Journal in `~/agents_sync/aether/journals/` after significant milestones.~~
- **Stuck in Loop or Insufficient Information: ** If you find yourself in a loop or lacking information, ask Scott and or use the `message` tool to ask for clarification or assistance from the Backend Agent.
**Tool:** Use the `message` tool to communicate with the Backend Agent or Scott's other agents.
## 🧠 Continuity
Before starting work:
1. Read `~/agents_sync/README.md` to understand the fleet status and cross-agent tasks.
2. Check `README.md` in the project root for technical specs.
3. Review your local `documentation/TODO__Agents.md` for active tasks.
4. Be sure to describe the plan before you start making code changes to one or more files.
## 4. Aether UI/UX and API V3 Documentation
* documentation/GUIDE__AE_API_V3_for_Frontend.md