diff options
| author | Juanito Fatas <katehuang0320@gmail.com> | 2014-05-30 10:35:12 +0800 |
|---|---|---|
| committer | Juanito Fatas <katehuang0320@gmail.com> | 2014-05-30 11:40:02 +0800 |
| commit | 5e3c0b28b8ce35403dadb3841566296f220a7c45 (patch) | |
| tree | 31f754574860d1e0625ab7299b586185d805f170 /guides | |
| parent | 74b73f132aab596ce509082fdf2b0e9dd4226e9c (diff) | |
| download | rails-5e3c0b28b8ce35403dadb3841566296f220a7c45.tar.gz rails-5e3c0b28b8ce35403dadb3841566296f220a7c45.tar.bz2 rails-5e3c0b28b8ce35403dadb3841566296f220a7c45.zip | |
[ci skip] Document Rails' shifted semver.
Diffstat (limited to 'guides')
| -rw-r--r-- | guides/source/maintenance_policy.md | 27 |
1 files changed, 23 insertions, 4 deletions
diff --git a/guides/source/maintenance_policy.md b/guides/source/maintenance_policy.md index 8f119f36aa..05c831ac0d 100644 --- a/guides/source/maintenance_policy.md +++ b/guides/source/maintenance_policy.md @@ -3,10 +3,29 @@ Maintenance Policy for Ruby on Rails Support of the Rails framework is divided into four groups: New features, bug fixes, security issues, and severe security issues. They are handled as -follows, all versions in x.y.z format +follows, all versions in `X.Y.Z` format. -------------------------------------------------------------------------------- +Rails follows a shifted version of [semver](http://semver.org/): + +**Patch `Z`** + +Only bug fixes, no API changes, no new features. +Except as necessary for security fixes or deprecations. + +**Minor `Y`** + +New features, may contain API changes (Serve as major versions of Semver). +Breaking changes are paired with deprecation notices in patch level release of +the last minor version level. + +**Major `X`** + +New features, will likely contain API changes. The difference between Rails' +minor and major releases is the magnitude of breaking changes, and usually +reserved for special occasions. + New Features ------------ @@ -20,7 +39,7 @@ Only the latest release series will receive bug fixes. When enough bugs are fixed and its deemed worthy to release a new gem, this is the branch it happens from. -**Currently included series:** 4.1.z, 4.0.z +**Currently included series:** `4.1.Z`, `4.0.Z`. Security Issues --------------- @@ -35,7 +54,7 @@ be built from 1.2.2, and then added to the end of 1-2-stable. This means that security releases are easy to upgrade to if you're running the latest version of Rails. -**Currently included series:** 4.1.z, 4.0.z +**Currently included series:** `4.1.Z`, `4.0.Z`. Severe Security Issues ---------------------- @@ -44,7 +63,7 @@ For severe security issues we will provide new versions as above, and also the last major release series will receive patches and new versions. The classification of the security issue is judged by the core team. -**Currently included series:** 4.1.z, 4.0.z, 3.2.z +**Currently included series:** `4.1.Z`, `4.0.Z`, `3.2.Z`. Unsupported Release Series -------------------------- |