Skip to content
This repository has been archived by the owner on Apr 12, 2022. It is now read-only.

Version number? #18

Closed
mhulse opened this issue Jun 29, 2012 · 0 comments
Closed

Version number? #18

mhulse opened this issue Jun 29, 2012 · 0 comments

Comments

@mhulse
Copy link

mhulse commented Jun 29, 2012

Hi! Thanks for this awesome plugin. :)

Any chance you could include a version number (and perhaps a simple changelog in the readme)?

I've always been keen on plugins that include a multi-line comment at the top of their plugin (minimized included):

/*
 * jQuery doTimeout: Like setTimeout, but better! - v1.0 - 3/3/2010
 * http://benalman.com/projects/jquery-dotimeout-plugin/
 * 
 * Copyright (c) 2010 "Cowboy" Ben Alman
 * Dual licensed under the MIT and GPL licenses.
 * http://benalman.com/about/license/
 */

At the very minimum, a version number makes it easy for end users to spot upgrades. :)

I've always liked this convention:

A normal version number MUST take the form X.Y.Z where X, Y, and Z are non-negative integers. X is the major version, Y is the minor version, and Z is the patch version. Each element MUST increase numerically by increments of one. For instance: 1.9.0 -> 1.10.0 -> 1.11.0.

More info here.

Lastly, I ussually ad version numbers to plugin file names (if I include them individually), for example:

jquery.mobilemenu-1.0.0.min.js

Thanks for your consideration!

Cheers,
Micky

@mhulse mhulse closed this as completed Aug 3, 2012
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant