From 7b073e703429a5240df616deea05b731b61c861d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Wed, 25 Oct 2023 15:57:41 +0200 Subject: [PATCH] add point about consistency in branch naming --- entries/git-workflow-guidelines/branching.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/entries/git-workflow-guidelines/branching.md b/entries/git-workflow-guidelines/branching.md index 89636aee..650b5548 100644 --- a/entries/git-workflow-guidelines/branching.md +++ b/entries/git-workflow-guidelines/branching.md @@ -58,6 +58,8 @@ If you want your branch to refer to a specific issue, this can also be included In addition, some teams include author initials in the branch names to keep track of developers' work, e.g., feature/skb-add-variance-plot. +These naming practices will help you avoid bad practices such as using numbers only and long branch names, as well as support consistency. Consistency in branch naming is important, so whenever you have chosen a convention, stick to it throughout the project to avoid confusion. + ## Summary - By default, a Git repository has one default branch called **main** @@ -67,6 +69,7 @@ In addition, some teams include author initials in the branch names to keep trac - In addition, we recommend the use of forward slash (/) after the prefix to create a nice ordering in many IDEs. E.g., "feature/" or "bugfix/" - If the work you are doing on a branch should refer to a particular issue, you can add the issue ID to the branch name after the prefix. E.g., "feature/12-fix-data-cleaning-error" - Collecting these recommendations, a branch name could be "feature/add-variance-plot" or "bugfix/12-fix-data-cleaning-error" +- When you have chosen a branch naming convention, be consistent and stick to it The naming scheme presented in this post is inspired by the following posts: