From 73876cf9cb16ab8ca9c761ae9204692b0f626477 Mon Sep 17 00:00:00 2001 From: Gilles Peskine Date: Tue, 8 Jun 2021 15:33:53 +0200 Subject: [PATCH] Clarify "between major version changes" This was diversely interpreted as "compatibility in the period between two major version changes" (as intended) or "compatibility between two versions whose major version is different" (unintended). Signed-off-by: Gilles Peskine --- BRANCHES.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/BRANCHES.md b/BRANCHES.md index df30ae100..b9926ac9d 100644 --- a/BRANCHES.md +++ b/BRANCHES.md @@ -16,9 +16,10 @@ At any point in time, we have a number of maintained branches consisting of: these only get bug fixes and security fixes. We use [Semantic Versioning](https://semver.org/). In particular, we maintain -API compatibility in the `master` branch between major version changes. We -also maintain ABI compatibility within LTS branches; see the next section for -details. +API compatibility in the `master` branch across minor version changes (e.g. +the API of 3.(x+1) is backward compatible with 3.x). We only break API +compatibility on major version changes (e.g. from 3.x to 4.0). We also maintain +ABI compatibility within LTS branches; see the next section for details. ## Backwards Compatibility