Permalink
Browse files

Versioning

  • Loading branch information...
1 parent f899c96 commit 76653b861b5e2401dc714205e3a138b71cf6f077 Ben Weissmann committed Aug 17, 2012
Showing with 19 additions and 2 deletions.
  1. +17 −0 README.md
  2. +1 −0 VERSION
  3. +0 −2 config/application.rb
  4. +1 −0 config/initializers/version.rb
View
@@ -140,6 +140,23 @@ Thanks for assistance and contributions:
* Edwin Chen, [@echen](https://twitter.com/echen)
* Dave Buchfuhrer [@daveFNbuck](https://twitter.com/daveFNbuck)
+## Versioning
+
+The current version is in the VERSION file and accessible in the code as
+ClockworkRaven::VERSION. Releases will be tagged with their release number in
+git.
+
+Clockwork Raven uses [semantic versioning](http://semver.org). Basically,
+this means that versions will be of the form X.Y.Z, where X is the major version
+(incremented when backwards-incompatible changes are introduced), Y is the minor
+version (incremented when backwards-compatible features are introduced), and X
+is the patch number (incremented when backwards-compatible bug fixes are
+introduced). Note however, that these are only hard rules once Clockwork Raven
+reaches 1.x. Until then, we will do our best to adhere to these policies
+(particularly with regards to not introducing backwards-incompatible changes in
+patch releases), but we may make backwards-incompatible changes while only
+incrementing the minor version number.
+
## License
Copyright 2012 Twitter, Inc.
View
@@ -0,0 +1 @@
+0.1.0
View
@@ -24,8 +24,6 @@
end
module ClockworkRaven
- VERSION = '0.1.0'
-
class Application < Rails::Application
TIME_FORMAT = "%a, %b %d, %Y %H:%M:%S %Z"
@@ -0,0 +1 @@
+ClockworkRaven::VERSION = IO.read(File.expand_path('../../../VERSION', __FILE__))

0 comments on commit 76653b8

Please sign in to comment.