🌿 Git Workflow

Version control practices for clean history and smooth collaboration.

Branching strategy

GitHub Flow (recommended for most teams)

main ──────────────────────────────►
  └── feature/add-auth ──► PR ──► merge
  └── fix/login-bug ──► PR ──► merge

Git Flow (for versioned releases)

main ────────────────────────────►
develop ──────────────────────────►
  └── feature/x ──► merge to develop
         └── release/1.0 ──► merge to main + tag

Branch naming

feature/short-description
fix/bug-description
chore/task-description
refactor/what-changed
docs/what-documented

Commit messages

Conventional Commits format

type(scope): description

feat(auth): add JWT refresh token support
fix(api): handle null response from payment provider
docs(readme): update installation instructions
refactor(db): extract query builder into separate module
test(auth): add unit tests for token validation

Types

feat, fix, docs, style, refactor, test, chore, perf, ci

PR workflow

1. Create a branch from main
2. Make small, focused commits
3. Push and open a PR with clear description
4. Request review from 1-2 team members
5. Address feedback, push updates
6. Squash merge (or merge commit per team convention)
7. Delete the branch after merge

Best practices

• Commit often, push regularly
• Never commit directly to main
• Rebase feature branches on main before merging
• Write meaningful commit messages (not "fix stuff")
• Don't commit secrets, env files, or build artifacts
• Use .gitignore properly