Add versioning policy

a7282ff8 · Thomas Daede · d7599d66 · a7282ff8
Commit a7282ff8 authored Apr 22, 2019 by Thomas Daede
Hide whitespace changes
Inline Side-by-side

Showing with 7 additions and 0 deletions

doc/VERSIONING.md doc/VERSIONING.md +7 -0

No files found.
--- a/doc/VERSIONING.md
+++ b/doc/VERSIONING.md
+rav1e follows Cargo's versioning scheme: https://doc.rust-lang.org/cargo/reference/manifest.html#the-version-field
+
+Because rav1e is not yet at version 1.0.0, all changes that break the API require a minor-version bump.
+
+The API is defined as:
+- public functions in src/api.rs
+- command line parameters to the rav1e binary