Skip to content

Commit

Permalink
add point about consistency in branch naming
Browse files Browse the repository at this point in the history
  • Loading branch information
signekb committed Oct 25, 2023
1 parent e559309 commit 7b073e7
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions entries/git-workflow-guidelines/branching.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand All @@ -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:

Expand Down

0 comments on commit 7b073e7

Please sign in to comment.