Skip to content

branch-naming-convention

A branch naming convention is a naming standard used in software development to clearly identify the purpose and context of a version control branch.^[001-TODO__test.md]

Structure

Based on observed usage within feature development, the naming structure typically follows a type/ticket_id_description format.^[001-TODO__test.md]

  • Type: The branch often begins with a prefix indicating the nature of the change, such as feature/.^[001-TODO__test.md]
  • Ticket ID: The name usually includes a numerical identifier corresponding to a task or feature request (e.g., 29153).^[001-TODO__test.md]
  • Description: A short, descriptive suffix (e.g., csv_export) is appended to summarize the specific work being done.^[001-TODO__test.md]

Scope

In specific instances involving microservices or multi-module projects, the branch name may be annotated to indicate which services or components are affected.^[001-TODO__test.md] For example, a branch might be explicitly associated with specific modules like plt-gateway or plt-basic.^[001-TODO__test.md]

  • [[Version Control]]
  • [[Feature Branch Workflow]]

Sources

  • 001-TODO__test.md