From 21a313a2e307a9da77791f7d7b2b49bc8b460386 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mart=C3=AD=20Malek?= Date: Thu, 6 Jun 2024 17:05:06 +0200 Subject: [PATCH] docs: add documentation about distribution channels --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3ab53ad47..ce0bec97e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -121,6 +121,14 @@ Speak out loud for us to understand your pains is valuable, challenge current ap Feel like doing a bit more? You can check what is up for grabs in our public backlog and create a PR for it +## Distribution channels + +We use [semantic release](https://semantic-release.gitbook.io/semantic-release) to automate our versioning and release process. Currently we have 3 distribution channels: + +- `latest` tag (follows the [main](https://github.com/freenowtech/wave/tree/main) branch): It is used for releases on the current major (v2) +- `next` tag (follows the [next](https://github.com/freenowtech/wave/tree/next) branch): It is used for prereleases on the next major (v3) +- `release-1.34.x` tag (follows the [1.34.x](https://github.com/freenowtech/wave/tree/1.34.x) branch): It is used to provide maintenance on our previous major version (v1) + ## Tools we use 1. We use [styled-components](https://www.styled-components.com/) to style our components.