Merge pull request metosin#237 from metosin/breakver

Announce that we use Break Versioning
joshkh · Mar 14, 2019 · ba93e3f · ba93e3f
2 parents f13d7ae + d0e43c1
commit ba93e3f
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,17 @@
+# Reitit CHANGELOG
+
+We use [Break Versioning][breakver]. The version numbers follow a `<major>.<minor>.<patch>` scheme with the following intent:
+
+| Bump    | Intent                                                     |
+| ------- | ---------------------------------------------------------- |
+| `major` | Major breaking changes -- check the changelog for details. |
+| `minor` | Minor breaking changes -- check the changelog for details. |
+| `patch` | No breaking changes, ever!!                                |
+
+`-SNAPSHOT` versions are preview versions for upcoming releases.
+
+[breakver]: https://github.com/ptaoussanis/encore/blob/master/BREAK-VERSIONING.md
+
 ## 0.3.0-SNAPSHOT
 
 ### `reitit.core`

diff --git a/doc/development.md b/doc/development.md
@@ -25,6 +25,10 @@ gitbook serve
 
 ## To bump up version:
 
+We use [Break Versioning][breakver]. Remember our promise: patch-level bumps never include breaking changes!
+
+[breakver]: https://github.com/ptaoussanis/encore/blob/master/BREAK-VERSIONING.md
+
 ```bash
 # new version
 ./scripts/set-version "1.0.0"