Do your branches have a naming convention?

Last updated by Christian Morford-Waite [SSW] about 1 month ago.See history

Have you ever looked at the list of branches in your repository and not know what they were for?

Consistent naming conventions in source control systems help improve collaboration, clarity, and organization across teams. Using meaningful branch names with PBI numbers enhances traceability and reduces merge debt.

Always remember to:

  • Include a PBI number - This makes it easy to track the purpose of the branch, reduces confusion, and provides context
  • Use lowercase kebab style naming - Keeps the name easy to read and compatible with a wide range of systems
  • Be descriptive - Clearly indicate the purpose or content of the branch
  • Keep it short - Use concise yet meaningful names
  • Extra: Use categories for improved organization - If your repository has many branches or you want to keep them organized, adding a prefix such as "feature", "bugfix", or "hotfix" is beneficial

Note: Release branches should always include a prefix (e.g., release/) to distinguish them from other branch types and keep them organized.


  • SomeUser-patch-3
  • fix-styling-issue
  • redirects
  • update-package-version
  • fix-stuff

Figure: Bad example - Poorly named branches missing PBI numbers

  • 1463-collection-categories
  • 1506-fix-storage-variable-yaml
  • 1299-update-third-party-dependencies

Figure: OK example - Branches with PBI numbers and meaningful names

  • feature/3421-add-search-functionality
  • bugfix/4578-fix-date-formatting-issue
  • hotfix/9845-patch-payment-api-timeout
  • release/2.3.1

Figure: Good example - Branches with category prefixes

{{ CATEGORY }}/{{ PBI NUMBER }}-{{ DESCRIPTION }}

Figure: Good example - Recommended naming format

❌ Avoid using SomeUser-patch-1

GitHub's automatically generated branch names like patch-1, patch-2, etc., are convenient for quick edits but lack context, making it difficult to identify the changes introduced. These branches are often used for typo fixes or minor documentation updates that are immediately raised as pull requests.

To improve clarity, use a descriptive name instead, such as fix-readme-typo instead of patch-1.


We open source.Loving SSW Rules? Star us on GitHub. Star
Stand by... we're migrating this site to TinaCMS