11# Backward compatibility policy for arduino-cli.
22
33The arduino-cli project follows a strict semantic versioning policy. We are committing not to make breaking changes in
4- minor releases after the release of version 1.0.0. The project is currently in the last period of the Beta phase .
4+ minor releases of Arduino CLI 1.x.x .
55
66The release rules are the following:
77
88- Alpha phase ` 0.0.X ` : In this phase, the software is going through a quick iteration of the API, each release (with
99 increments of X) may contain massive and breaking changes.
10- - ** Beta phase ` 0.Y.X ` ** : The software is usable, but the API is still not settled and is under continuous testing and
10+ - Beta phase ` 0.Y.X ` : The software is usable, but the API is still not settled and is under continuous testing and
1111 review. Breaking changes are expected. Bug fixes and new features are made as patch releases (with increments of X).
1212 Breaking changes due to API refinements are made as minor releases (with increments of Y).
1313- Production release-candidate ` 1.0.0-rc.X ` : in this phase, the software is considered ready for release and distributed
1414 to the users for final testing. Release candidates (with increments of X) are possible for bug fixes only.
15- - Production release ` 1.Y.X ` : For the production releases backward compatibility is guaranteed, and all the breaking
15+ - ** Production release ` 1.Y.X ` ** : For the production releases backward compatibility is guaranteed, and all the breaking
1616 changes are cumulated for the next major release (2.0.0). Bug fixes are made as patch releases (with increments of X);
1717 New features are released as minor releases (with increments of Y).
18- - Next major release development ` 2.0.0 ` and up: see below.
18+ - Next major release development ` >= 2.0.0` and up: see below.
1919
2020## Backward compatibility guarantees and definition of "breaking change"
2121
@@ -36,7 +36,7 @@ Changes in the command-line interface are considered breaking if:
3636- an optional positional argument or a flag is made mandatory
3737- a positional argument or a flag format is changed
3838
39- The following changes to the command-line syntax are NOT considered breaking:
39+ The following changes to the command-line syntax are NOT considered breaking changes :
4040
4141- a new command is added
4242- a new optional positional argument is added
0 commit comments