From 4aede678f5e905cc8873dff8933f17407c9822b4 Mon Sep 17 00:00:00 2001 From: Clemens Tolboom Date: Mon, 4 Dec 2023 14:43:25 +0100 Subject: [PATCH] chore: add section about conventional commits --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c867efd85..df29d9f96 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,6 +36,18 @@ We have several components - [release](./scripts/release/) source - [ops](./scripts/ops/README.md) readme +## Releasing + +We release through [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) which autoincrement using [Semantic versioning](https://semver.org/). + +Use `./gradlew nyxMake` to see what is build in [build/distributions](./build/distributions/). + +List messages to see usage of conventional commits from the past. + +```sh +git log --pretty=format:"%s" | cut -c -20 +``` + ## Profile xenon with resourcer whitelisted returns a host.docker.internal error When developing locally, it might be possible to come across the container error: `Could not resolve host: host.docker.internal`, especially when developing on a non-supported operating system when resourcer is whitelisted (such as xenon).