armin/linspector
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README update.

Browse source
This commit is contained in:
Johannes Findeisen 2022-09-29 05:33:54 +02:00
commit 1486fc7305
1 changed files with 17 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -95,12 +95,27 @@ According to: [https://wiki.unixpeople.org/linux_kernel_version_numbering](https
**MAJOR**.**FEATURE**.**MINOR**.**FIXES** **MAJOR**.**FEATURE**.**MINOR**.**FIXES**
- **MAJOR** changes _can_ change the API. The lesser, the better. - **MAJOR** changes _can_ change the API. The lesser, the better.
- **FEATURE** changes can, but _should_ not break the API. New features are placed - **MINOR** changes can, but _should_ not break the API. New features are placed
here. It _expects_ a complete documentation. here. It _expects_ a complete documentation.
- **MINOR** changes are "just-in-time" changes or small enhancements which _should_ - **MAINTENANCE** changes are "just-in-time" changes or small enhancements which _should_
not affect the documentation and _must_ not break the API. not affect the documentation and _must_ not break the API.
- **FIXES** _must_ never affect anything else then stability or security. - **FIXES** _must_ never affect anything else then stability or security.
To be compliant to Python packaging guidelines Linspector uses the following versioning
scheme. I Need to think about my current version scheme because it is not 100% compatible with
the following:
- 1.2.0.dev1 - Development release
- 1.2.0a1 - Alpha Release
- 1.2.0b1 - Beta Release
- 1.2.0rc1 - Release Candidate
- 1.2.0 - Final Release
- 1.2.0.post1 - Post Release
- 15.10 - Date based release
- 23 - Serial release
[https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools/#choosing-a-versioning-scheme](https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools/#choosing-a-versioning-scheme)
### Configuration file rules ### Configuration file rules
- No inline comments so every available character can be used in values - No inline comments so every available character can be used in values