yuxuanhui
25 lines
785 B
Markdown
25 lines
785 B
Markdown
# Domain Docs
|
|
|
|
Before exploring a topic, read `CONTEXT.md` at the repo root when it exists, then read the relevant ADRs under `docs/adr/`.
|
|
|
|
Missing context files should be ignored silently. Create `CONTEXT.md` lazily only when domain terminology or a durable decision needs to be recorded.
|
|
|
|
## File structure
|
|
|
|
This repository uses a single-context layout:
|
|
|
|
```text
|
|
/
|
|
├── CONTEXT.md
|
|
├── docs/adr/
|
|
└── src/
|
|
```
|
|
|
|
## Vocabulary
|
|
|
|
Use the project's established domain terms in issue titles, proposals, tests, and documentation. If a term is unclear or missing, treat it as a signal to clarify the domain model rather than inventing a synonym.
|
|
|
|
## ADR conflicts
|
|
|
|
If a proposal contradicts an existing ADR, call out the conflict explicitly instead of silently overriding it.
|