Skip to content

Commit dfef372

Browse files
authored
Explain version schema (#2284)
1 parent 388ab66 commit dfef372

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,18 @@ PyModbus - A Python Modbus Stack
1111

1212
Pymodbus is a full Modbus protocol implementation offering client/server with synchronous/asynchronous API a well as simulators.
1313

14+
Our releases is defined as X.Y.Z, and we have strict rules what to release when:
15+
16+
- **Z**, No API changes! bug fixes and smaller enhancements.
17+
- **Y**, API changes, bug fixes and bigger enhancements.
18+
- **X**, Major changes in API and/or method to use pymodbus
19+
20+
Upgrade examples:
21+
22+
- 3.6.1 -> 3.6.9: just plugin the new version, no changes needed.
23+
- 3.6.1 -> 3.7.0: Smaller changes to the pymodbus calls might be needed
24+
- 2.5.4 -> 3.0.0: Major changes in the application might be needed
25+
1426
Current release is `3.7.0 <https://github.com/pymodbus-dev/pymodbus/releases/tag/v3.7.0>`_.
1527

1628
Bleeding edge (not released) is `dev <https://github.com/pymodbus-dev/pymodbus/tree/dev>`_.

0 commit comments

Comments
 (0)