Branch Naming Strategy

Intro

In an effort to keep a common naming convention for branches, lets try to stick to a common convention.

The Convention

Generally, we will stick to a convention like the following:

<change_type>/<project_name>/<name>

 

<change_type>:

  • bug

  • feature

  • chore

 

<project_name>:

  • sm

  • am

  • tm

  • pm

  • driver

  • infra

  • milestonex

 

<name>: the actual name you want to give the branch

 

For example, if you are implementing a new driver for airspeed, you would name it something like feature/driver/airspeed.

If have a a milestone branch for milestone 1 and we encounter a math bug for the airspeed sensor that we need to fix, we could name the branch to fix the bug bug/milestone1/fix-airspeed-math.