[pidget-cvs] pidget/doc versions.txt,NONE,1.1

[<lke...@us...>]

Update of /cvsroot/pidget/pidget/doc
In directory sc8-pr-cvs1:/tmp/cvs-serv27328/doc

Added Files:
	versions.txt 
Log Message:
* Added release notes
* Added a document explaining how Pidget handles versioning


--- NEW FILE: versions.txt ---
VERSIONS - Pidget's Version Numbering Scheme
Pidget - The PHP Widget Library
================================================================================

We take a pretty traditional Linux kernel style of version numbering for Pidget.
It works something like this:

    <MAJOR>.<MINOR>.<ITERATIVE>

MAJOR:  The major release number is reserved for large architectural changes
that most likely will significantly break backwards compatibility.

MINOR:  The minor release number is very important.  Odd minor release numbers
indicate a development release branch, and even numbers indicate a stable
branch.  For example, 1.2.0 would be a stable release, while 1.3.2 would be a
development release.  Typically there are two versions maintained, a stable
release branch and a development release branch.  This is talked about in more
detail later in this document.

ITERATIVE:  The final number is just a counter that starts at 0 and goes up as
high as necessary to indicate successive release numbers.  For example, 1.2.1 is
the release following 1.2.0.


Branches
========
We typically maintain two branches of code simultaniously:  the development
branch and the stable branch.  The development branch is where all the action is
happening.  New features will be added to it between releases, and compatibility
may break between releases.  The development branch is not intended for
production use except by the very brave.

Then we have the stable branch.  The idea behind it is to have a branch where no
features are added, but only bug fixing occurs.  New releases will be more
stable than the previous.  It is always recommended to run the latest stable
release as it has the most recent bug fixes.  These versions will always be
compatible with each other.  For example, 1.2.1 can be swapped out and 1.2.4 put
in its place without having to change any code in your applications.  (At least
that is the idea)