This project follows a Feature Branching Strategy with automated semantic versioning and changelog generation. All developers must follow these guidelines to ensure proper CI/CD pipeline execution.
All branch names must follow this pattern:
^(main|feature|bugfix)\/*$
feature/CORE-777-add-bancolombia-payment-method
feature/some-important-feature
feature/xyz-33
bugfix/small-bug-fix-ui-interface
bugfix/fix-login-validationmy-feature # Missing prefix
develop # Not allowed in this strategy
feature_new_thing # Use hyphens, not underscores# Create feature branch from main
git checkout main
git pull origin main
git checkout -b feature/CORE-777-add-payment-method
# Make your changes and commit
git add .
git commit -m "feat: add Bancolombia payment integration"
git push origin feature/CORE-777-add-payment-method
# Create Pull Request to main
# When merged → Triggers MINOR version bump (e.g., 1.0.0 → 1.1.0)# Create bugfix branch from main
git checkout main
git pull origin main
git checkout -b bugfix/fix-login-validation
# Make your changes and commit
git add .
git commit -m "fix: resolve login validation error for special characters"
git push origin bugfix/fix-login-validation
# Create Pull Request to main
# When merged → Triggers PATCH version bump (e.g., 1.1.0 → 1.1.1)Use conventional commit format for automatic changelog generation:
<type>: <description>
[optional body]
| Type | Description | Changelog Category | Validation |
|---|---|---|---|
feat |
New feature | 🚀 Features | ✅ Required |
feature |
New feature | 🚀 Features | ✅ Required |
fix |
Bug fix | 🐛 Bug Fixes | ✅ Required |
fixbug |
Bug fix | 🐛 Bug Fixes | ✅ Required |
feat: add Bancolombia payment integration
feat(auth): implement OAuth integration
fix: resolve login validation for special characters
fix(ui): correct button alignment on mobileupdated code # No type prefix
fix stuff # Vague description
WIP # Work in progress commitsLabel your PRs to ensure proper changelog categorization:
| Label | Category | Version Impact |
|---|---|---|
feature, feat |
🚀 Features | Minor bump |
bug, bugfix |
🐛 Bug Fixes | Patch bump |
When you merge to main:
- PR Validation runs first (branch name + commit message validation)
- GitVersion calculates the new version based on branch type
- Changelog is automatically generated from commit messages and PR titles
- CHANGELOG.md file is updated in the repository
- Git tag is created (e.g.,
v1.2.0) - GitHub Release is published with changelog as release notes
- Feature branch merge → Minor version increase (1.0.0 → 1.1.0)
- Bugfix branch merge → Patch version increase (1.0.0 → 1.0.1)
- Breaking changes → Major version increase (1.0.0 → 2.0.0)
- Clean versioning: Generates clean tags like
v1.2.3(no CI suffixes)
# 1. Start new feature
git checkout main
git pull origin main
git checkout -b feature/CORE-123-user-profile
# 2. Make changes with conventional commits
git add .
git commit -m "feat: add user profile editing functionality"
git commit -m "feat: implement profile picture upload"
git commit -m "test: add tests for profile validation"
# 3. Push and create PR
git push origin feature/CORE-123-user-profile
# Create PR with labels: feature, enhancement
# 4. After review and merge to main:
# ✅ Validation checks must pass first
# ✅ CI/CD automatically:
# - Bumps version to 1.1.0 (minor)
# - Updates CHANGELOG.md
# - Creates v1.1.0 tag
# - Publishes GitHub releaseEvery pull request automatically triggers validation checks:
- Checks pattern:
^(main|feature|bugfix)\/*$ - Must pass before other validations run
- Provides clear feedback with examples
- Validates all commits in the PR
- Enforces conventional commit format
- Supports optional scope:
feat(scope): description - Automatically detects and skips merge commits using:
- Parent count check (merge commits have multiple parents)
- Message pattern matching for various merge formats
- Only runs if branch name validation passes
- Only triggers after successful PR merge to main
- Depends on validation passing
- Generates semantic version based on branch type
- Simplified categorization shows only:
- 🚀 Features:
feat:andfeature:commits - 🐛 Bug Fixes:
fix:andbugfix:commits
- 🚀 Features:
- Smart filtering excludes unwanted commits:
- Merge commits (e.g., "Merge pull request #123...")
- Changelog update commits (e.g., "chore: update CHANGELOG.md...")
- Commits tagged with
[skip-changelog] - All other commit types (docs, chore, style, etc.)
- Clean format with proper categorization and no "Uncategorized" sections