Skip to content

Commit 2b0635a

Browse files
Added text about versionning.
1 parent 546adc9 commit 2b0635a

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,18 @@ Metacello new
1313

1414
Once Python3Generator is installed in your image, you need to configure [Python3Generator](https://github.com/juliendelplanque/Python3Generator) to use the Python interpreter you prefer. My advise is to use the FFI interpreter using: `P3GInterpreter useFFIInterpreter`. If your `python3` binary is located in a standard path in your file system, it should be fine, else you can manually set the path to `python3` binary using for example: `P3GInterpreter current pathToPython: '/usr/bin/python3'`.
1515

16+
## Version management
17+
18+
This project use semantic versionning to define the releases. This mean that each stable release of the project will get associate a version number of the form `vX.Y.Z`.
19+
20+
- **X** define the major version number
21+
- **Y** define the minor version number
22+
- **Z** define the patch version number
23+
24+
When a release contains only bug fixes, the patch number increase. When the release contains new features backward compatibles, the minor version increase. When the release contains breaking changes, the major version increase.
25+
26+
Thus, it should be safe to depend on a fixed major version and moving minor version of this project.
27+
1628
## Examples
1729
### Getting os information in `/tmp/os.json` file
1830
```

0 commit comments

Comments
 (0)