mirror of
https://github.com/Vateron-Media/XC_VM.git
synced 2026-10-04 12:02:33 +02:00
Divarion_D
a0ed41df16
Per-repo config the engineering skills read: docs/agents/issue-tracker.md (GitHub Issues via gh for Vateron-Media/XC_VM) and docs/agents/domain.md (single-context CONTEXT.md + docs/adr/ consumer rules).
36 lines
1.4 KiB
Markdown
36 lines
1.4 KiB
Markdown
# Domain Docs
|
|
|
|
How the engineering skills should consume this repo's domain documentation when exploring the codebase.
|
|
|
|
This is a **single-context** repo: one `CONTEXT.md` and one `docs/adr/` at the repo root.
|
|
|
|
## Before exploring, read these
|
|
|
|
- **`CONTEXT.md`** at the repo root (if it exists).
|
|
- **`docs/adr/`** — read ADRs that touch the area you're about to work in.
|
|
|
|
If any of these files don't exist, **proceed silently**. Don't flag their absence; don't suggest creating them upfront. The `/domain-modeling` skill (reached via `/grill-with-docs` and `/improve-codebase-architecture`) creates them lazily when terms or decisions actually get resolved.
|
|
|
|
## File structure
|
|
|
|
```
|
|
/
|
|
├── CONTEXT.md
|
|
├── docs/adr/
|
|
│ ├── 0001-....md
|
|
│ └── 0002-....md
|
|
└── src/
|
|
```
|
|
|
|
## Use the glossary's vocabulary
|
|
|
|
When your output names a domain concept (in an issue title, a refactor proposal, a hypothesis, a test name), use the term as defined in `CONTEXT.md`. Don't drift to synonyms the glossary explicitly avoids.
|
|
|
|
If the concept you need isn't in the glossary yet, that's a signal — either you're inventing language the project doesn't use (reconsider) or there's a real gap (note it for `/domain-modeling`).
|
|
|
|
## Flag ADR conflicts
|
|
|
|
If your output contradicts an existing ADR, surface it explicitly rather than silently overriding:
|
|
|
|
> _Contradicts ADR-0007 (...) — but worth reopening because…_
|