From d20e9439384e863744ac8cc2b524e2d12fe87ad8 Mon Sep 17 00:00:00 2001 From: Dave Date: Tue, 21 May 2024 16:59:44 +0200 Subject: [PATCH] add motivation to branch naming rule --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 82822c2cb3..1ef3ed6670 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -54,7 +54,7 @@ On the release day, **devel** branch is merged into **master**. All releases of ### Branch naming rules -We are using the following branch naming pattern (all lowercase and dashes, no underscores): +We want to make sure that our git history explains in a human readable way what has been changed with which Branch or PR. To this end, we are using the following branch naming pattern (all lowercase and dashes, no underscores): ```sh {category}/{ticket-id}-description-of-the-branch @@ -73,7 +73,7 @@ feat/4922-add-avro-support #### Ticket Numbers -We encourage you to attach your branches to a ticket, if none exists, create one an explain what you are doing. For feat and fix branches, tickets are mandatory, for exp and test branches encouraged and for blogs and cos branches optional. +We encourage you to attach your branches to a ticket, if none exists, create one an explain what you are doing. For feat and fix branches, tickets are mandatory, for exp and test branches encouraged and for blogs and docs branches optional. ### Submitting a hotfix