From 1ef30669731aed20392a579f12eea01497f708f6 Mon Sep 17 00:00:00 2001 From: Benjamin Geck Date: Tue, 5 Mar 2024 13:05:39 +0000 Subject: [PATCH] add branch naming conventions rule --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 811817b..a98cbbf 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,12 @@ There are a set of rules to keep in mind: > Because this way all work is done in isolation on a dedicated branch rather than the main branch. It allows you to submit multiple pull requests without confusion. You can iterate without polluting the master branch with potentially unstable, unfinished code. [read more...](https://www.atlassian.com/git/tutorials/comparing-workflows#feature-branch-workflow) +- Name your feature branches consistently. Agree with your team on a naming convention such as `feat/[task-id]/descriptive-text`. + + _Why:_ + + > Having a consistent naming convention helps communicate needed information across the team and keep branches organized. + - Branch out from `develop` _Why:_