Git Workflow

Git Workflow

Quick Start

# Create feature branch
git checkout -b feat/add-user-auth

# Make changes and commit
git add src/auth/
git commit -m "feat(auth): add user authentication"

# Push and create PR
git push -u origin feat/add-user-auth
gh pr create --title "feat(auth): add user authentication" --body "..."

Branch Naming

type/description

Conventional Commits

type(scope): subject

body (optional)

footer (optional)

Types

Scopes

Custom scopes allowed. Scope is optional.

Rules

• Subject: imperative mood, no period, lowercase
• Header max length: 200 characters
• Body: optional, use | for line breaks in interactive mode

Examples

# Feature
git commit -m "feat(auth): add password reset flow"

# Bug fix
git commit -m "fix(ui): correct button alignment on mobile"

# Chore
git commit -m "chore(deps): update react to v19"

# With scope
git commit -m "refactor(database): simplify user queries"

# Without scope
git commit -m "docs: update README installation steps"

PR Creation

gh pr create --title "feat(auth): add user authentication" --body "$(cat <<'EOF'
## Summary
- Add login/logout functionality
- Add session management
- Add auth middleware

## Test plan
- [ ] Verify login flow works
- [ ] Verify logout clears session
- [ ] Verify protected routes redirect
EOF
)"

PR Template

## Summary

<1-3 bullet points describing the change>

## Test plan

- [ ] Unit tests pass
- [ ] Manual testing completed
- [ ] Edge cases verified

Full Workflow

# 1. Create branch from main
git checkout main
git pull
git checkout -b feat/my-feature

# 2. Make changes
# ... edit files ...

# 3. Stage and commit
git add src/
git commit -m "feat(scope): add feature description"

# 4. Push to remote
git push -u origin feat/my-feature

# 5. Create PR
gh pr create --title "feat(scope): add feature description" --body "..."

# 6. After review, merge
gh pr merge --squash

Common Mistakes

Delegation

• Branch strategy questions: Ask user for preferences
• Merge conflicts: Use git mergetool or resolve manually
• PR reviews: Use code-reviewer agent

Source: oakoss/open-saas-kit — distributed by TomeVault.