Vortex Stability

[gatesn]

Figured it was time to write down where we are in terms of stability guarantees across the various components of Vortex.

🟢 File Format

Backwards compatible from 0.36.0 onward, so all future readers will be able to read Vortex files created by writers >=0.36.0.

🟢 Arrays + Layouts

All existing arrays and layouts within the Vortex repository are considered stable in their serialized form and will be supported by future readers.

🟠 IPC Format

We do not consider the IPC format to be stable, however this is only because we are not aware of any current usage of this format. If you make use of the IPC format, please open a Discussion and we can look to officially stabilize.

🟠 Language APIs

All language APIs are considered unstable, meaning updates to the Vortex libraries may require changes in user code.

Where breaks occur, we:

• Guarantee the PR will be marked with the break label
• Guarantee the PR description will detail a migration path from the old API to the new API
• Aim to mark existing APIs deprecated if it is reasonable to introduce the new API alongside the existing one.