Git branch naming

Git branch naming #

Format #

When creating a branch name you must use one of these prefixes <type>/ along with short <issue title> and <issue number>, so <type>/<ticket-title>/<ticket-id>, example: refactor/filer-tech-debt/777

Type #

Always choose one of those type

  • ci: Changes to our CI configuration files and scripts
  • doc: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

Example:

ci/<issue-title>/123 - for ci/cd fix for github issue 123
feat/<issue-title>/567 - feature request for the github issue 567
fix/<issue-title>/321 - fix for the github issue 321

Issue title #

Simply use an issue title if possible. If issue title is too long cut it to 25 characters.

Issue id #

Picket up issue id/ticket number from your ticket tracker. In cause if you have multiple trackers, use commit message guidelines to reference issue tracker with git commit