Skip to content

Instantly share code, notes, and snippets.

@ciatph

ciatph/branch-namin-conventions.md

Last active July 31, 2022 20:25
Show Gist options
  • Save ciatph/1e460be1823d799bfe7a9f5a5c7a021f to your computer and use it in GitHub Desktop.
Save ciatph/1e460be1823d799bfe7a9f5a5c7a021f to your computer and use it in GitHub Desktop.
Download ZIP
Branch Naming Conventions
Raw
branch-namin-conventions.md

Branch Naming Conventions

(from @Phil Nord

Some Useful Guidelines

  1. Use grouping tokens (words) at the beginning of your branch names.
  2. Define and use short lead tokens to differentiate branches in a way that is meaningful to your workflow.
  3. Use slashes to separate parts of your branch names. 4.5Do not use bare numbers as leading parts.
  4. Avoid long descriptive names for long-lived branches.

Group tokens

group1/foo
group2/foo
group1/bar
group2/bar
group3/bar
group1/baz

Short well-defined tokensgroup tokens

wip       Works in progress; stuff I know won't be finished soon
feat      Feature I'm adding or expanding
bug       Bug fix or experiment
junk      Throwaway branch created to experiment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment