40 lines
1.8 KiB
Markdown
40 lines
1.8 KiB
Markdown
# Project Contract
|
|
|
|
Every client AI workspace owns its client context. Keep the project root small, explicit, and safe to open directly in VS Code.
|
|
|
|
## Instruction layout
|
|
|
|
- Root `AGENTS.md`: a short, mandatory router. It tells an agent to read the local `PROJECT.md` and this Core `AGENTS.md` before work.
|
|
- `PROJECT.md`: client and project facts, local source priority, repository map, raw DDR location, and organization-specific standards.
|
|
- Core skills: task-specific procedures read only when relevant.
|
|
|
|
Do not use a filesystem symlink for `PROJECT.md`; track it directly in the client repository.
|
|
|
|
## Project-owned material
|
|
|
|
- client name and project scope
|
|
- confirmed business rules and decisions
|
|
- tickets, project notes, and approved analysis
|
|
- sanitized parsed DDR
|
|
- FileMaker work scripts and project-specific prompts
|
|
- the location and environment names of raw DDR exports
|
|
|
|
## Standard workspace map
|
|
|
|
- `TICKETS/`: one folder per ticket or workstream, including its source requests, handoffs, analysis, questions, reports, assets, and ticket-specific scripts.
|
|
- `FMSCRIPTS/`: tracked complete `.fmscript` files that are not clearly ticket-specific or apply across workstreams.
|
|
- `NOTES/`: confirmed knowledge that applies across more than one ticket.
|
|
- `DDR-Parsed/`: tracked generated reference material; do not edit it manually.
|
|
- sibling `DDR/`: local raw DDR input; never commit it.
|
|
|
|
## Core-owned material
|
|
|
|
- generic FileMaker analysis and scripting workflow
|
|
- reusable prompts and templates
|
|
- generic DDR handling and secret-safety guidance
|
|
- client-neutral helper scripts
|
|
|
|
## Instruction precedence
|
|
|
|
When guidance conflicts, preserve project evidence and confirmed client decisions. A project may opt into an additional organization-specific standard without applying it to other clients.
|