Skip to content
Source
Sign inSign up
TanStack/db

test: make oracle models executable documentation #1870

MergedKyleAMathews(GitHub profile, opens in a new tab)merged 6 commits intomain fromrefs/pull/1870/headmerged by KyleAMathews(GitHub profile, opens in a new tab)

Showing 135 changed files with 225 additions and 0 deletions (loading 132).

x
0 of 135 viewed, 135 left
5 additions and 0 deletions.changeset/clear-oracle-models.mdAdded
View file
@@ -0,0 +1,5 @@
+---
+'@tanstack/db': patch
+---
+​
+Document oracle tests as executable subsystem models, align their vocabulary with production code, and make deterministic failures easier to replay.
40 additions and 0 deletionsAGENTS.mdModified
View file
@@ -13,6 +13,41 @@
If a change intentionally revises an architectural contract, update the
architecture document in the same pull request.
​
+## Required reading: executable subsystem models
+​
+Read `docs/contributing/glossary.md` before naming or renaming a subsystem
+state, action, boundary, or observation. Production code, executable models,
+tests, and design documents must use the same term for the same concept. A
+model may stay structurally independent, but it must declare any abstraction
+that combines, splits, or does not correspond to production concepts.
+​
+Some oracle files are also the shortest documentation for their subsystem.
+Before changing a covered contract or its machinery, use
+`docs/contributing/oracle-coverage.md` to find the primary executable owner and
+read its stated limits. Do not infer authority from a filename alone.
+​