Branch Name Standardization

[husamettinarabaci]

There are some best practice standards for branch naming.

Basic Rules

• Lowercase and Hyphen-separated: Stick to lowercase for branch names and use hyphens to separate words. For instance, feature/new-login or bugfix/header-styling.
• Alphanumeric Characters: Use only alphanumeric characters (a-z, 0–9) and hyphens. Avoid punctuation, spaces, underscores, or any non-alphanumeric character.
• No Continuous Hyphens: Do not use continuous hyphens. feature--new-login can be confusing and hard to read.
• No Trailing Hyphens: Do not end your branch name with a hyphen. For example, feature-new-login- is not a good practice.
• Descriptive: The name should be descriptive and concise, ideally reflecting the work done on the branch.

Branch Prefixes

Using prefixes in branch names helps to quickly identify the purpose of the branches. Here are some common types of branches with their corresponding prefixes:

• Feature Branches: These branches are used for developing new features. Use the prefix feature/. For instance, feature/login-system.
• Bugfix Branches: These branches are used to fix bugs in the code. Use the prefix bugfix/. For example, bugfix/header-styling.
• Hotfix Branches: These branches are made directly from the production branch to fix critical bugs in the production environment. Use the prefix hotfix/. For instance, hotfix/critical-security-issue.
• Release Branches: These branches are used to prepare for a new production release. They allow for last-minute dotting of i’s and crossing t’s. Use the prefix release/. For example, release/v1.0.1.
• Documentation Branches: These branches are used to write, update, or fix documentation. Use the prefix docs/. For instance, docs/api-endpoints.

Actually, I like another one:
I am giving names to branches in this format;
{issue_type}/{my_short_tag}/{issue_id}/{little_description}

Some examples:

• feature/hsm/23/delivery-module
• fix/hsm/784/validate-problem
• change/hsm/42/json-format-change
• hotfix/hsm/1/bulk-fix

Those are like my branch's names. I recommend using the same format as this in all of the OctopOSPrime branches.
If you have any other good ideas. Please feel free to write here.

@octoposprime/design
@octoposprime/design-jr
@octoposprime/design-tl
@octoposprime/be
@octoposprime/be-jr
@octoposprime/be-tl
@octoposprime/mo
@octoposprime/mo-jr
@octoposprime/mo-tl
@octoposprime/devops
@octoposprime/devops-jr
@octoposprime/devops-tl
@octoposprime/game
@octoposprime/game-jr
@octoposprime/game-tl
@octoposprime/em
@octoposprime/em-jr
@octoposprime/em-tl
@octoposprime/web
@octoposprime/web-jr
@octoposprime/web-tl
@octoposprime/fe
@octoposprime/fe-jr
@octoposprime/fe-tl
@octoposprime/docs
@octoposprime/docs-jr
@octoposprime/docs-tl
@octoposprime/arc
@octoposprime/arc-jr
@octoposprime/arc-tl