Skip to content

Commit f381aad

Browse files
docs: document version-gated falsifiers
Signed-off-by: TMHSDigital <154358121+TMHSDigital@users.noreply.github.com> Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 5cac0d6 commit f381aad

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,21 @@ and the product scripts that self-skip: `examples/gn-bundle-roundtrip/`,
143143
`examples/exit-pre-sidecar/`). A script under test prints `SMOKE_SKIP:` and
144144
exits 77; the runner records SKIP and returns 0 so the YAML step stays green.
145145

146+
**Version-gated falsifiers.** A falsifier for a cross-version removal or
147+
rename is version-gated by nature. It exits its documented code on versions
148+
where the API changed and exits 0 on versions where the old API still works.
149+
That is the correct witness: the naive script is still valid on the older
150+
binaries. It differs from every other falsifier in the tree (for example
151+
`--same-axis`), which is red on all three versions.
152+
153+
Do not "fix" these flags to fail unconditionally. The examples that behave
154+
this way:
155+
156+
- `examples/vse-linear-modifiers/` (`--assume-present`)
157+
- `examples/gn-socket-rename/` (`--legacy-ids`)
158+
- `examples/eval-mesh-datablock-name/` (`--assume-distinct-names`)
159+
- `examples/mesh-automasking-settings/` (`--assume-brush-attrs`)
160+
146161
## Standards-version Markers
147162

148163
Files that participate in ecosystem drift checking must carry a `standards-version` marker matching the current meta-repo `STANDARDS_VERSION` (which is decoupled from this repo's `VERSION`):

0 commit comments

Comments
 (0)