Skip to content

Instantly share code, notes, and snippets.

@jcran
Forked from revett/git_branch_naming.md
Last active October 20, 2021 18:53
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save jcran/7b19fa30bc9833917c0d7ef74b3ea5b8 to your computer and use it in GitHub Desktop.
Save jcran/7b19fa30bc9833917c0d7ef74b3ea5b8 to your computer and use it in GitHub Desktop.
Git Branch Naming Conventions

<type>/<name>

<type>

bug    - Code changes linked to a known issue.
feat   - New feature.
hotfix - Quick fixes to the codebase.
spike   - Spikes (will probably not be merged - just investigating / testing before moving to a feature branch).

<name>

Always use underscores to seperate words, and keep it short.

Examples

feat/renderer_cookies
hotfix/dockerfile_base_image
bug/login_snafu_sorted
spike/neptune_for_data_layer

Note that we don't track ticket ID ... this is intentional, as they may change and are better suited for the PR itself.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment