Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.88 KB

Naming-conventions-for-new-branches.md

File metadata and controls

37 lines (24 loc) · 1.88 KB
Raw

◀️ Back

Using the slash character in Git branch name

When creating a new branch in git, you need to use the slash character to separate the Theme / name-of-branch. By Theme we mean you need to use one of different themes (or Trello labels) the EOS roadmap uses:

  1. ui
  2. ux
  3. ops (don't use operations, gitlab seems to have conflicts letting you push folders with that name)
  4. engagement
  5. training
  6. front-end
  7. fruit
  8. bugs
  9. fastlane

The Theme and Branch name should always be in lowercase and for the branch name if it contains more than 1 words in it, use minus (-) to separate them

Valid example: ui/collapsible-notifications Invalid example: UI/Collapsible-Notifications

This theme will be easy for you to find out since it will be part of the card you are working on. If the card you are working on has no theme, then this card is not properly following the Definition of Ready and it should be moved back to the backlog column New cards

Using the slash character to separate Theme and Branch-name will, in the end, be detected by most git software, as a directory/file format, improving the browsing of extensive lists of branches for later review.

Using fork for Mac?

Download from: https://git-fork.com/

If you do, you will notice that using the slash character when naming branches makes it very easy to navigate through branches since it will show you folders for all the pre-slash names, themes in our case. In fork you will see something like this:

image

Avoid conflicts

Names need to be unique. For example, you can't have both a file and a directory with the same name. This means you should never name a branch simply UX because it will cause conflicts with all the other branches that are named UX/branch-name, UX/main-navigation, etc.