Browse files

Add Versioning section

  • Loading branch information...
1 parent f52c42d commit cf70f2075ffc2e3e459970b9ad2e4ed48ba250fa @sferik sferik committed Dec 2, 2012
Showing with 17 additions and 1 deletion.
  1. +17 −1 README.md
View
18 README.md
@@ -61,7 +61,7 @@ client = Octokit::Client.new(:login => "me", :password => "sekret")
client.follow("sferik")
```
-Alternately, you can authenticate with a [GitHub OAuth2 token][oauth].
+Alternately, you can authenticate with a [GitHub OAuth2 token][oauth].
```ruby
client = Octokit::Client.new(:login => "me", :oauth_token => "oauth2token")
@@ -130,6 +130,22 @@ implementation, you will be personally responsible for providing patches in a
timely fashion. If critical issues for a particular implementation exist at the
time of a major release, support for that Ruby version may be dropped.
+## Versioning
+
+This library aims to adhere to [Semantic Versioning 2.0.0][semver]. Violations
+of this scheme should be reported as bugs. Specifically, if a minor or patch
+version is released that breaks backward compatibility, that version should be
+immediately yanked and/or a new version should be immediately released that
+restores compatibility. Breaking changes to the public API will only be
+introduced with new major versions. As a result of this policy, you can (and
+should) specify a dependency on this gem using the [Pessimistic Version
+Constraint][pvc] with two digits of precision. For example:
+
+ spec.add_dependency 'octokit', '~> 1.0'
+
+[semver]: http://semver.org/
+[pvc]: http://docs.rubygems.org/read/chapter/16#page74
+
### JSON dependency
Since JSON is included in 1.9 now, we no longer include it as a hard

0 comments on commit cf70f20

Please sign in to comment.