diff --git a/README.md b/README.md index bf631c57..cfb311d1 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,8 @@ Please use the [conventional commit format](https://www.conventionalcommits.org/ We use [goreleaser](https://goreleaser.com) to help us automate releases. We use [semver](https://semver.org) for versioning all releases of the tool. While we are still in the public alpha release phase, we will maintain a `0.y.z-alpha` format. Change logs are generated from our commit logs. We are still working this out and aim to refine our release praxis as we go. +For developers, while using this `-alpha` format, the `y` part is the "major" version part. So, if you make breaking changes, you increment that and _not_ the `x` part. So, if you're on `0.1.0-alpha`, then you'd go to `0.1.1-alpha` for a backwards compatible change and `0.2.0-alpha` for a backwards incompatible change. + ## Fork maintenance We maintain a fork of [godotenv](https://github.com/Autonomic-Cooperative/godotenv) for two features: