search

wormjam-consortium / wormjam

Website/Repository containing the WormJam genome scale model
https://wormjam.life
Creative Commons Attribution 4.0 International
4 stars 11 forks source link

Release versions #10

Open michaelwitting opened 5 years ago

michaelwitting commented 5 years ago

Hi,

I suggest that we add folder called release_versions beside our model_versions folder to store ready to use versions of the model. We also have to come up with version numbering and a system for the numbering. I suggest that the next stable version will become WormJam 1.0, after we found the problems with ATP production. Version numbers would increase in the following manner 1.X.Y. Y increases if minor changes like metabolite structure curation etc was performed. X increases if some bigger changes have been made, e.g. a new set of reactions or a new pathway has been added. A new full version would be for example expansion of compartments or other rather major changes.

Let me know your thoughts.

Michael

JakeHattwell commented 5 years ago

I like the idea of versioning. Github does have an inbuilt release system, in which we can make a "public release", such as version 1.0.0. We don't have to use a different folder for it, however, as it will be available from the release history section of the github page.

As for the versioning, I'd advocate using the Semantic Versioning system https://semver.org/