search

mantle-convection-constrained / terratools

Tools to read, analyse and visualise models written by the TERRA mantle convection code
https://terratools.readthedocs.io/en/latest/
MIT License
7 stars 5 forks source link

Semantic versioning #149

Open anowacki opened 8 months ago

anowacki commented 8 months ago

@jamespanton93 I notice that in a recent patch release (v1.0.1 –> v1.0.2) we added a new feature. semver.org suggests that patch bumps are for bugfixes, while minor version increments are for new features. (Major version bumps are for incompatible changes.) I have mentioned this in CONTRIBUTING.md; so really we should be on v1.1.0 now. Do we think this is enough for the devdocs, or should we add more about this?

jamespanton93 commented 8 months ago

Yes you are correct. Perhaps the only thing to add is what sort of changes warrant a patch release. Perhaps Do you think we should retrospectively move to v.1.1.0 now? I should also add an example of how to use the new feature.

anowacki commented 8 months ago

At this stage I think we can leave it and not release another version, but it would be good to ensure we follow our policies in future.

If you think a bit more devdoc discussion on semver is needed beyond what's there, then feel free to add something. We can leave this open for that in the meantime.