Add a rule about how to advance the ISSO version number and a version constant file

* docs/versioning_rules.txt: Outlines the procedures for updating the version number
* version.php: The version number stored in a file

diff --git a/docs/versioning_rules.txt b/docs/versioning_rules.txt
new file mode 100644 (file)
index 0000000..e908603
--- /dev/null
+++ b/docs/versioning_rules.txt
@@ -0,0 +1,42 @@
+VERSIONING RULES
+
+This file outlines the rules for versioning the ISSO framework.
+===============================================================
+
+Final releases have a version number in the form of A.B.C
+
+  A
+-----
+       This is the major version number and should not change unless total
+       API breakage occurs or a major restructuring of the code is done.
+       Currently, the major version is 3 and in the foreseeable future it
+       will remain at this version.
+
+
+  B
+-----
+       If *any* API changes occur at all this number should be updated.
+       This includes renaming, parameter changes, type changes, or any other
+       change that would affect how an application would interact with the
+       framework. It would not be unreasonable for this number to be relatively
+       high (like 20, or even 100). The logic behind versioning API changes
+       is for compatibility reasons.
+
+  C
+-----
+       The only changes not covered so far by this versioning scheme are bug fixes.
+       ISSO code should be fixed that any minor change (including documentation)
+       or changeset should be placed in its own separate version. Releases
+       should be numerous and fast to ensure that the most recent version is
+       as bug-free as possible. As with the 'B' place, it is acceptable for this
+       number to be very high.
+
+All releases should be tagged in git with the proper version number, as well
+as updating the ISSO_VERSION constant in version.php so applications can
+check for framework compatibility.
+
+Pre-release versions should not be released. Ever. We do not want people
+building applications with unreleased versions of ISSO, so all tagged
+and released versions of the framework should be stable and ready for
+production use. (We already made the mistake of using ISSO3 development
+code in ViewSVN ... and then it all changed).
\ No newline at end of file

diff --git a/version.php b/version.php
new file mode 100644 (file)
index 0000000..da7a22c
--- /dev/null
+++ b/version.php
@@ -0,0 +1,27 @@
+<?php
+/*=====================================================================*
+|| ###################################################################
+|| # Blue Static ISSO Framework
+|| # Copyright (c)2005-2008 Blue Static
+|| #
+|| # This program is free software; you can redistribute it and/or modify
+|| # it under the terms of the GNU General Public License as published by
+|| # the Free Software Foundation; version 2 of the License.
+|| #
+|| # This program is distributed in the hope that it will be useful, but
+|| # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+|| # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+|| # more details.
+|| #
+|| # You should have received a copy of the GNU General Public License along
+|| # with this program; if not, write to the Free Software Foundation, Inc.,
+|| # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+|| ###################################################################
+\*=====================================================================*/
+
+/**
+ * ISSO version
+ */
+define('ISSO_VERSION', '3.0.0');
+
+?>
\ No newline at end of file