OpenMS / OpenMS

The codebase of the OpenMS project
https://www.openms.de
Other
468 stars 307 forks source link

Semantic Versioning? #5574

Open fabianegli opened 2 years ago

fabianegli commented 2 years ago

I was unable to find a commitment to a specific versioning scheme. Wouldn't it make sense to commit to one so other tools know what to expect? e.g. https://github.com/fabianegli/proteomicslfq/blob/dev/bin/scrape_software_versions.py tries to extract the version with too simple a regex. Committing to a versioning scheme would allow to use a regex that is guaranteed to work.

This would not need any code change, but an addition to the documentation:

timosachsenberg commented 2 years ago

good point we will bring this up on our regulr developer meetings

tapaswenipathak commented 2 years ago

What is the documentation todo? Should this be closed?

jpfeuffer commented 2 years ago

We should document on how we version. I.e. what a minor version increase means for us. We are currently not strictly sticking to semantic versioning. It is tricky while our tools and library are versioned together.