20 lines
793 B
ReStructuredText
20 lines
793 B
ReStructuredText
Output compatibility
|
|
====================
|
|
|
|
Reports and serialized records are consumed by automation, so their fields,
|
|
ordering assumptions, and error semantics are compatibility-sensitive.
|
|
Changes to output code require focused tests and a fixed-input comparison
|
|
before they are treated as behavior-preserving.
|
|
|
|
When changing an output format:
|
|
|
|
* document the intended consumer impact;
|
|
* preserve stable fields where possible;
|
|
* add a narrow unit or integration test for the changed contract;
|
|
* compare output from equivalent fixed inputs; and
|
|
* state any deliberate incompatibility in release notes once a public release
|
|
process exists.
|
|
|
|
Do not interpret this document as a versioned external API promise. A public
|
|
versioning and release policy has not been established for this checkout.
|