Branch Naming Convention - AvengerDisassemble/KU-connect GitHub Wiki

To keep our Git workflow clean and consistent, we use the following branch naming format:

<Type>/<Team>/<Description>

Represents the purpose of the branch. Use one of these keywords:

• feature → For new features.
• bugfix → For fixing bugs.
• hotfix → For urgent fixes in production.
• chore → For maintenance tasks (e.g., config, dependencies).
• refactor → For code restructuring without changing functionality.
• test → For adding or updating tests.
• docs → For documentation changes.

You can add more types later if needed, but keep it simple to avoid confusion.

Represents which part of the system is mainly responsible for the change:

• frontend → UI, styling.
• backend → APIs, database, server logic.
• devops → CI/CD, deployment, infra.

A short, kebab-case description of the branch purpose.

• Keep it clear and concise.
• Examples:
  • api-authentication
  • fix-navbar-style
  • upgrade-tailwind

• Always use lowercase and kebab-case for descriptions.
• Keep descriptions short but meaningful.
• Each branch should focus on one task/issue.
• Match branch type with PR/MR title for clarity.

• feature/backend/add-user-login
• bugfix/frontend/fix-dashboard-layout
• chore/devops/update-dockerfile
• docs/frontend/add-readme-guide
• refactor/backend/cleanup-auth-service