git-workflow

Git Workflow

Follow these conventions for all git operations.

Branch Naming

{type}/{ticket-id}-{short-description}

Type	Purpose	Example
feature/	New features	feature/TKT-123-user-auth
fix/	Bug fixes	fix/TKT-456-login-error
hotfix/	Production fixes	hotfix/TKT-789-security-patch
refactor/	Code refactoring	refactor/TKT-101-cleanup-api
docs/	Documentation	docs/TKT-102-api-docs
test/	Test additions	test/TKT-103-unit-tests

Commit Messages

Use conventional commits format:

{type}({scope}): {description}

{body - optional}

{footer - optional}

Types

• feat: New feature
• fix: Bug fix
• refactor: Code refactoring (no functional change)
• test: Adding or updating tests
• docs: Documentation only
• chore: Maintenance tasks
• style: Formatting, whitespace (no code change)
• perf: Performance improvement

Examples

# Simple commit
git commit -m "feat(auth): add JWT token validation"

# With body
git commit -m "fix(api): handle null user in response

The API was returning 500 when user was not found.
Now returns 404 with proper error message.

Fixes TKT-456"

# Breaking change
git commit -m "feat(api)!: change response format to JSON:API

BREAKING CHANGE: Response format changed from custom to JSON:API spec.
Migration guide: docs/migration/v2-response-format.md"

Workflow Commands

Starting Work

# Create feature branch from main
git checkout main
git pull origin main
git checkout -b feature/TKT-123-feature-name

# Or from develop for GitFlow
git checkout develop
git pull origin develop
git checkout -b feature/TKT-123-feature-name

During Development

# Stage and commit changes
git add -A
git commit -m "feat(scope): description"

# Keep branch updated
git fetch origin
git rebase origin/main  # or origin/develop

Before PR

# Ensure clean history
git rebase -i HEAD~{n}  # Squash if needed

# Push to remote
git push -u origin feature/TKT-123-feature-name