- Notifications
You must be signed in to change notification settings - Fork0
unifiedbits/branching-guidelines
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
To ensure a clean, scalable, and team-friendly development workflow, UnifiedBits follows a consistent branching strategy using base and working branches.
- 🔒Production-ready branch
- Always contains the lateststable release
- Direct changes are restricted; merged only through pull requests (usually from
dev)
- 🚧Primary development branch
- All new features and fixes are merged into
devfirst - Acts as a staging area before pushing to production (
main) - Frequently rebased or updated from
mainto stay in sync
| Branch Type | Purpose | Example |
|---|---|---|
feature/ | For adding new features | feature/api-user-dashboard |
fix/ | For bug fixes | fix/ui-navbar-overlap |
refactor/ | For internal refactoring (no behavior change) | refactor/core-cleanup |
docs/ | For documentation updates | docs/readme-api-guide |
test/ | For adding or modifying tests | test/auth-unit-tests |
chore/ | For setup/config/CI/CD work | chore/ci-add-lint-check |
hotfix/ (optional) | For urgent fixes to production (main) | hotfix/api-token-expiry |
Always follow this structure when naming your branches:
<branch-type>/<domain>-<short-description>Use lowercase letters and hyphens for readability.
feature/auth-add-otp-loginfix/ui-fix-navbar-overlaprefactor/api-cleanup-old-endpointsdocs/readme-update-api-usagetest/dashboard-add-user-metrics-tests| Domain | Description |
|---|---|
auth | Authentication logic |
ui | User interface |
api | Backend endpoints |
dashboard | Analytics & reporting |
core | Business logic |
readme | Project documentation |
ci | Continuous Integration/Deployment |
infra | Infrastructure & DevOps |
🛑Always create your branch from the latestdev branch to ensure you're working with the most recent code.
Checkout and pull the latest
dev:git checkout devgit pull origin dev
Create your new branch from
dev:git checkout -b feature/ui-add-sidebar
Work on your feature/fix and commit usingConventional Commits:
feat(ui): add collapsible sidebar component
Push your branch:
git push origin feature/ui-add-sidebar
Open a Pull Request to
devfor review.✅ Once reviewed and tested, maintainers will merge
devintomainwhen ready for production.
- Sync
devregularly withmain - Delete local and remote feature branches after merge
- Never commit directly to
mainordevunless it's critical (viahotfix/)
| Branch | Purpose |
|---|---|
main | Stable production-ready code |
dev | Integration of features & fixes |
feature/ | New enhancements & modules |
fix/ | Bug fixes |
hotfix/ | Emergency production fixes |
docs/ | Documentation-only changes |
test/ | Testing logic |
chore/ | Meta tasks & setup |
“Organized branches mean faster development and cleaner launches.” — UnifiedBits
Let’s branch smartly and build boldly! 🚀
About
A practical guide to consistent branching strategies and naming across UnifiedBits projects.
Topics
Resources
Uh oh!
There was an error while loading.Please reload this page.