- Added to AI_MANDATES.md section 3 (Operational Guardrails) - Added to CLAUDE.md as critical directive - Ensures all feature changes are transparent and require explicit user consent - This prevents accidental removal of functionality
49 lines
2.7 KiB
Markdown
49 lines
2.7 KiB
Markdown
# AI AGENT MANDATES - SINGLE SOURCE OF TRUTH
|
|
|
|
**READ THIS ENTIRE FILE BEFORE EXECUTING ANY TASK.**
|
|
This is the foundational directive for all AI operations on the TFM aInventory project.
|
|
|
|
---
|
|
|
|
## 1. Memory, Traceability & Handover
|
|
- **Startup Protocol**: Read `dev_docs/SESSION_STATE.md` immediately at session start to understand the current context.
|
|
- **Handover Requirement**: Update `dev_docs/SESSION_STATE.md` at the end of every session with:
|
|
- **Active AI**: Your name/version.
|
|
- **Current Status**: Precise summary of what was achieved.
|
|
- **Context**: Any critical details found or technical decisions made.
|
|
- **Next Steps**: Explicit instructions for the next AI session.
|
|
- **Archive Protocol**: Before writing new state, move previous content to `dev_docs/SESSION_HISTORY.md`.
|
|
- **Communication**: Be concise. Focus on signal over noise.
|
|
|
|
## 2. Source Control & Versioning
|
|
- **Branch Strategy**: Work primarily in the `dev` branch. Feature branches are acceptable but must be merged back to `dev`.
|
|
- **Atomic Commits**: Each commit should represent a single logical change.
|
|
- **Version Bump**: You MUST run `python3 scripts/save_version.py` before finalizing any task that modifies code or functionality. This tool increments the version and updates `VERSION.json`.
|
|
|
|
## 3. Operational Guardrails
|
|
- **No Interaction Overlap**: Never modify a file if another AI session is explicitly working on it (check `dev_docs/SESSION_STATE.md`).
|
|
- **Standard Respect**: Rigorously follow `DESIGN_SYSTEM.md` and `CODING_STANDARDS.md`.
|
|
- **Conflict Resolution**: If project files contradict your internal training, **this file and local project docs take absolute precedence.**
|
|
- **Uppercase Rule**: NEVER use `uppercase` or `toUpper` in UI contexts. Leave text case as is or use Title/Sentence case.
|
|
- **⚠️ MANDATORY: No Silent Feature Removal** — **NEVER remove, disable, or hide any existing function or functionality without:**
|
|
1. **Explicitly informing the user** exactly what is being removed and why.
|
|
2. **Obtaining express written consent** from the user before proceeding.
|
|
3. **If already removed**, restore it immediately and apologize. This is non-negotiable.
|
|
|
|
## 4. Documentation SSOT Integrity
|
|
Every feature change or refactor MUST be reflected across the documentation suite:
|
|
1. `README.md` (Quick Start/Features)
|
|
2. `USER_GUIDE.md` (User workflows)
|
|
3. `ARCHITECTURE.md` (System logic)
|
|
4. `DESIGN_SYSTEM.md` (UI/UX specs)
|
|
5. `ROADMAP.md` (Project progress)
|
|
|
|
## 5. AI Command Shortcuts
|
|
- **`save-version`**:
|
|
- Update all relevant documentation.
|
|
- Run `python3 scripts/save_version.py`.
|
|
- Follow the script's automated prompts for commits and branching.
|
|
|
|
---
|
|
**Status**: ACTIVE | **Last Updated**: 2026-04-26
|