diff --git a/CHANGELOG.md b/CHANGELOG.md index 22c439f4..ff2f9433 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,17 @@ +# Reitit CHANGELOG + +We use [Break Versioning][breakver]. The version numbers follow a `..` 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 index d40b4253..425b68f3 100644 --- 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"