1- = Versioning and Compatibility
1+ = Versioning and compatibility
22
33The version number is defined in `InterfaceVersion::version_number` in `osi_version.proto` as the field's default value.
44
55OSI uses https://semver.org/[Semantic Versioning].
66
77Major::
8- A change of the major version results in an incompatibility of code and recorded proto messages.
8+ A change in the major version makes the code and recorded proto messages incompatible .
99+
1010Major changes include:
1111+
12- * An existing field with a number changes its meaning.
12+ * An existing field with a number changing its meaning.
1313Example: `optional double field = 1;` changes to `repeated double field = 1;` .
1414* Changing the definition of units or the interpretation of a field.
1515* Deleting a field and reusing the field number.
1616* Changing the technology from Protocol Buffers to FlatBuffers.
1717
1818Minor::
19- A change of the minor version indicates remaining compatibility to previously recorded files.
20- The code on the other hand needs fixing.
19+ A change in the minor version indicates there is still compatibility with previously recorded files.
20+ However, the code needs fixing.
2121+
2222Minor changes include:
2323+
@@ -26,10 +26,10 @@ Minor changes include:
2626* Adding a new field in a message without changing the numbering of other fields.
2727
2828Patch::
29- The compatibility of both recorded files and code remains .
29+ Both recorded files and code still have compatibility .
3030+
3131Patches include:
3232+
33- * File or folder structure which does not affect including the code in other projects.
33+ * File or folder structure that does not affect integration of the code in other projects.
3434* Changing or adding comments.
35- * Clarification of text passages explaining the message content.
35+ * Clarifying text passages explaining the message content.
0 commit comments