search

kraftbj / genesis-enews-extended

WordPress widget to provide additional functionality to the Genesis eNews widget.
https://kraft.blog/genesis-enews-extended/
Other
12 stars 15 forks source link

Use semantic versioning #12

Closed GaryJones closed 11 years ago

GaryJones commented 11 years ago

There really shouldn't be a need to go into four digits for a version number. See http://semver.org/ which would allow you to give a clear indication to developer users about what type of changes a new version has (non-backwards-compatible, backwards-compatible new features, bug fixes).

kraftbj commented 11 years ago

One question I'm not sure about reading through and searching the web -- the "release" I'm wanting to commit next is just adding two new translations and updating another. That would best be considered a patch release, no? (e.g. x.y.1)

Again, appreciate the guidance. Cheers!

GaryJones commented 11 years ago

The two new translations, to me, would be a new feature - a y release. Nothing is breaking (so not an x release), but it isn't solely a bug fix z release (which the updated language file on it's own would be).

kraftbj commented 11 years ago

That makes sense. Abandoning the planned 0.1.6.1 and releasing as 0.2 to begin x.y.z style. Fixed: SHA: 5a7f08911cbc06284b6411a0076dcf87f466af78

GaryJones commented 11 years ago

To follow the WP standard, it should be 0.2.0 and not just 0.2 - this would enable searching for exactly 0.2.0 in since, version and deprecated documentation tags, and not capturing later releases accidentally if you could only search by 0.2

GaryJones commented 11 years ago

Since the plugin is working, even if not quite how you'd like it, it really could just go to version 1.0.0 - the semantic versioning makes more sense then, as you're not limiting yourself to numbers after the initial 0.

kraftbj commented 11 years ago

That makes sense (0.2 vs 0.2.0). I like the look of 0.2, but that's a poor reason to go against a standard and a reasonable one at that, eh? :+1:

I thought about the 0.2.0 vs 1.0.0. Again, may be a poor reason, but thinking of waiting until a "bigger" feature was bring released (e.g. the requested ability to use a shortcode or something like that). Part of my thought is I don't want to confuse people on why a seemingly minor release (code cleanup and translations) would trigger a jump from 0.x to 1.0.0

GaryJones commented 11 years ago

Marketing can still be done with the short version (Like Genesis 1.9 is), but all references in code should be the longer version (1.9.0 in Genesis).

On it's own, I agree about the otherwise confusing jump to 1.0.0, but then I rarely start at a version less than 1 anyway - there are other ways to communicate that something is not yet production ready. The fact that GEE was production ready from the start, having been pulled out working from Genesis, means, IMO, the first version of this standalone should have been 1.0.0.