62 lines
3.8 KiB
Markdown
62 lines
3.8 KiB
Markdown
# AI AGENT RULES - MANDATORY SSOT ENTRY POINT
|
|
|
|
**READ THIS ENTIRE FILE BEFORE EXECUTING ANY TASK.**
|
|
This is the **Single Source of Truth** for ALL AI agents. Refer to [PROJECT_ARCHITECTURE.md](PROJECT_ARCHITECTURE.md) for technical logic.
|
|
|
|
---
|
|
|
|
## 1. AI MEMORY, TRACEABILITY & HANDOVER
|
|
- **MANDATORY STARTUP**: Read `dev_docs/SESSION_STATE.md` immediately at session start.
|
|
- **PLAN RETIREMENT**: Mark a completed "Master Plan" as `[COMPLETED]` in the file itself. Move technical details to `dev_docs/ARCHIVE_LOGS.md` and `PLAN.md` entries to `dev_docs/PLAN_HISTORY.md`.
|
|
- **STRICT HANDOVER**: Update `dev_docs/SESSION_STATE.md` at the end of every task with: **Active AI**, **Current Status** (Stable/Broken/In-Progress), **Context**, and **Next Steps**.
|
|
- **SESSION ARCHIVE**: Move previous handover content to `dev_docs/SESSION_HISTORY.md` before writing new state.
|
|
- **NO INTERACTION OVERLAP**: Never modify a file if another AI session is explicitly working on it.
|
|
- **CONCISE COMMUNICATION**: Be concise! Do not explain a thousand details unless they are absolutely necessary.
|
|
|
|
## 2. ENGINEERING & OPERATIONAL LAWS
|
|
- **ENGLISH ONLY**: Interfaces, code, variables, and docs MUST be in English. Translate any Romanian text found in code immediately. (User conversation: Romanian/English).
|
|
- **GIT PROTOCOL**: Use the direct binary path `/Library/Developer/CommandLineTools/usr/bin/git`) for ALL Git operations. **DO NOT REMOVE OR CHANGE THIS PATH UNDER ANY CIRCUMSTANCES!** Never push or use `--force` unless explicitly asked. Branching: `master` (stable), `dev` (active), `vX` (archive).
|
|
- **VERSIONING**: Update `VERSION.json` on every commit. Use `scripts/save_version.py` for automated releases.
|
|
- **DEPENDENCIES**: Update `backend/requirements.txt` with version constraints for every new pip package.
|
|
- **SSOT INTEGRITY**: Every feature change MUST update: `README.md`, `USER_GUIDE.md`, `PROJECT_ARCHITECTURE.md`, and `export_prod.sh`.
|
|
|
|
## 3. UI/UX "PREMIUM" FIDELITY STANDARDS
|
|
- **Aesthetics**: Density/aesthetics must remain "Premium". Use Tailwind CSS. NO simplification.
|
|
- **Typography Rules**:
|
|
- **NO UPPERCASE** or **NO ITALICS** in headers, labels, buttons, or metadata.
|
|
- **NO `tracking-widest`**. Use standard camel/Title case.
|
|
- Use `font-black` for main headings.
|
|
- **Layout**: Main pages MUST use `max-w-7xl`.
|
|
- **Unified Headers**: Icon box (`p-4 bg-primary/10 border-primary/20`) + Title (`text-3xl font-black`) + Subtitle (`text-xs text-slate-500`).
|
|
- **Iconography**: Use **Lucide Icons** exclusively (NO emojis).
|
|
- **Categories**: `Layers` (text-primary).
|
|
- **Item Types**: `Package` (text-green-500).
|
|
- **Affordance**: Dropdowns MUST have a `ChevronDown`. Passwords: `text-white/50`. Logout MUST be `text-rose-500`.
|
|
|
|
## 4. DATA INTEGRITY & AUDIT POLICY
|
|
- **RESTRICTED ACTIONS**: `DELETE /items/` and Admin settings require `auth.get_current_admin`.
|
|
- **AUDIT IMMUTABILITY**: Deleting an `Item` MUST NOT delete its `AuditLog` entries.
|
|
- **TRACEABILITY**: Log deletions to `logs/backend.log` with `USER[id]`, `ITEM[id]`, `Name`, `PN`.
|
|
- **CONFIRMATION**:
|
|
- **Triple Confirmation**: Deleting critical entities (Locations/Items) requires user confirmation 3 times.
|
|
- **Native Alerts**: Use `window.confirm` for all destructive UI actions and Logout.
|
|
|
|
## 5. AI COMMAND SHORTCUTS
|
|
- **`save-version`**:
|
|
0. **MANDATORY**: Verify and update ALL documentation (`.md` files: README, USER_GUIDE, ARCHITECTURE, etc.) with explanations of all current changes.
|
|
1. Increment `VERSION.json`.
|
|
2. Git add/commit (`Build [vX.Y.Z]`).
|
|
3. Create branch `vX.Y.Z` (Snapshot).
|
|
4. Automatic Sync: Merge changes into `master` branch to keep it up-to-date.
|
|
5. Run `./export_prod.sh`.
|
|
(Always use `python3 scripts/save_version.py`).
|
|
|
|
---
|
|
|
|
## END OF SESSION PROTOCOL
|
|
End your final response on a separate line exactly with:
|
|
```
|
|
---
|
|
✓ Done.
|
|
```
|