diff --git a/README.md b/README.md index c5103790..46509be6 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,17 @@ Use this command to port a given PR of `PR_NUMBER` to the other branches: backport --pr PR_NUMBER -b ros2-humble ros2-iron ros2-jazzy ``` +# Versioning and Releases + +- (__X__.0.0) We use the major version number to indicate a breaking change. +- (0.__Y__.0) The minor version number is used to differentiate between different ROS distributions: + - x.__0__.z: Humble Hawksbill + - x.__1__.z: Iron Irwini + - x.__2__.z: Jazzy Jalisco + - x.__3__.z: Rolling Ridley + - Future releases (Kilted Kaiju 05/25) will get x.__3__.z and _Rolling_ will be incremented accordingly. +- (0.0.__Z__) The patch version number is used for changes in the current ROS distribution that do not affect the API. + # License The source code is released under a [BSD 3-Clause license](LICENSE).