Home

🌿 UniPlan GitHub Branch Naming Guide

All branches must follow this format:

<type>/<short-description>

---

🔑 Allowed Types

• feature → New features or enhancements
• bugfix → Bug fixes
• hotfix → Critical fixes for production
• release → Release preparation branches
• docs → Documentation changes

---

📏 Rules

1. No ticket numbers in branch names (❌ T-456).
2. Use lowercase letters, numbers, and hyphens (-) only.
3. Short description should be 3–5 words.
4. Can also add number behind if you do same thing but different branch
5. Be clear and concise.

---

✅ Examples

• feature/user-authentication
• bugfix/fix-header-styling-2
• hotfix/security-patch-1
• release/v2.0.1
• docs/update-readme

---

❌ Bad → ✅ Good

• feature/T-456-user-authentication → feature/user-authentication
• bugfix/T-789-fix-header-styling → bugfix/fix-header-styling
• hotfix/T-321-security-patch → hotfix/security-patch
• docs/T-654-update-readme → docs/update-readme