Announce that we use Break Versioning

This commit is contained in:
Miikka Koskinen 2019-03-14 09:50:21 +02:00
parent f13d7ae0db
commit d0e43c17a2
2 changed files with 18 additions and 0 deletions

View file

@ -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`

View file

@ -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"