Last updated
Tips for Good Branch Names
- Always include the ticket/issue number — it enables automatic linking in Jira, GitHub, and GitLab
- Use the type prefix (feature/, fix/, hotfix/) so CI/CD pipelines can trigger the right workflows
- Keep names descriptive but concise — aim for 3–6 words after the prefix
- Use hyphens, not underscores — hyphens are more readable in terminal output
- Avoid personal names (e.g., "johns-branch") — branch names should describe the work, not the person
- Delete branches after merging to keep the repository clean
Examples
Example 1: Feature Branch Names
Input natural language descriptions and get properly formatted branch names:
Input Description | Generated Branch Name
-------------------------------------------|------------------------------------------
Add OAuth login with Google | feature/add-oauth-login-google
Fix the login button not working on mobile | fix/login-button-not-working-mobile
Update user profile page layout | feature/update-user-profile-page-layout
Refactor payment processing module | refactor/payment-processing-module
Add dark mode support | feature/add-dark-mode-support
Fix broken image links on homepage | fix/broken-image-links-homepage
Example 2: Ticket Number Integration
Include Jira, GitHub Issues, or Linear ticket numbers in branch names:
Jira format:
Ticket: AUTH-1234
Description: Add OAuth login
→ feature/AUTH-1234-add-oauth-login
GitHub Issues format:
Issue: #456
Description: Fix checkout total calculation
→ fix/456-checkout-total-calculation
Linear format:
Ticket: ENG-789
Description: Migrate database to PostgreSQL
→ feature/ENG-789-migrate-database-postgresql
GitLab Issues format:
Issue: !321
Description: Update API rate limiting
→ feature/321-update-api-rate-limiting
Example 3: Naming Convention Formats
The generator supports multiple team conventions — choose the one that matches your workflow:
Convention: type/description
feature/user-authentication
fix/null-pointer-exception
hotfix/payment-gateway-timeout
release/v2.1.0
chore/update-dependencies
Convention: type/ticket-description
feature/AUTH-1234-user-authentication
fix/BUG-567-null-pointer-exception
hotfix/INC-89-payment-gateway-timeout
Convention: username/feature
alice/user-authentication
bob/payment-refactor
carol/dark-mode
Convention: type/username/description
feature/alice/user-authentication
fix/bob/payment-null-pointer