Commit cf3d850
authored
docs: define file format stability contract (#7779)
This codifies how Lance contributors should reason about stable and
unstable file format changes. Stable formats remain backward- and
forward-compatible, while unstable formats may evolve without
compatibility shims for unreleased intermediate states.
It also scopes protobuf compatibility accordingly, keeping decisions
anchored to the latest released stable format instead of transient
behavior on a development branch or `main`.
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Added guidance for evaluating file-format stability and compatibility.
* Clarified backward-compatibility requirements for stable and persisted
formats.
* Documented that unstable-only formats do not require compatibility
migrations or safeguards.
* Added verification steps before making potentially breaking Protobuf
schema changes.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->1 parent 45bc880 commit cf3d850
2 files changed
Lines changed: 8 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
33 | 39 | | |
34 | 40 | | |
35 | 41 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
| 8 | + | |
8 | 9 | | |
9 | 10 | | |
10 | 11 | | |
| |||
0 commit comments