From 9409d2b21955fca17af4f62dffbd9d15f7306470 Mon Sep 17 00:00:00 2001 From: Silvio Traversaro Date: Fri, 3 Oct 2025 10:10:13 +0200 Subject: [PATCH] Add compatibility policy --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 50782fc..bd6bc11 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,10 @@ Alternatively, in case you do not want to modify all your code from `serial::` * Change the `#include ` inclusion to `#include ` +### Compatibility Policy + +This project tries to avoid removing functionalities in minor releases, while functionalities are only removed in major version. However, this is only done in a best-effort way, and it may be possible that backward incompatibly changes occur in minor releases (see [EffVer](https://jacobtomlinson.dev/effver/) for more details). Furthermore, the policy is that patch releases does not modify at all the public headers (i.e. the installed `.h` and `.hpp`) files of the project. This is done to ensure that no ABI change will occur in patch releases, without having to manually track ABI changes. + ### License [The MIT License](LICENSE)