Skip to content

Commit 5a09fdb

Browse files
authored
Add compatibility policy (#15)
1 parent fa05db6 commit 5a09fdb

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,10 @@ Alternatively, in case you do not want to modify all your code from `serial::`
8181

8282
* Change the `#include <serial/serial.h>` inclusion to `#include <serial_cpp/serial_compat.h>`
8383

84+
### Compatibility Policy
85+
86+
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.
87+
8488
### License
8589

8690
[The MIT License](LICENSE)

0 commit comments

Comments
 (0)