Git Workflows

⚒️ Our Git Workflow

---

🌳 Branch Structure

• main — always deployable (production)
• dev — integration branch for ongoing work
• feature/* — short-lived branches for new tasks
• hotfix/* — urgent fixes from main (for “oh shit” fixes only)

---

🦒 Workflow Steps

1. Clone the Repo

git clone <github-url>

2. Create and Use the dev Branch (if dev branch already exists, skip to 3)

git switch -b dev
git push -u origin dev

3. Start a New Feature

git switch dev
git pull origin dev
git switch -b feature/your-task-name

4. Make Changes and Commit

git commit -m "Describe what you did"
git push -u origin feature/your-task-name

5. Create a Pull Request (PR)

• Merge into dev when reviewed and approved

6. Deploy to Production

git switch main
git pull origin main
git merge dev
git push origin main

7. Optional: Tag the Release

git tag -a v1.0.0 -m "First release"
git push origin --tags

8. Hotfixes (Critical Fixes)

git checkout main
git pull origin main
git checkout -b hotfix/issue-name

# After fix:
git add .
git commit -m "Fix critical issue"
git push origin hotfix/issue-name

# PR to main, then merge into dev too

---

📊 Visual Flow

          +------------------+
          |     main         |
          | (production)     |
          +--------+---------+
                   ^
                   |
         Merge to main when stable
                   |
            +------v------+
            |     dev     |
            | (staging)   |
            +------+------+
                   ^
                   |
    +--------------+---------------+
    |                              |
+---v------------------+   +-------v------------------+
| feature/your-feature |   | hotfix/critical-issue    |
| (off of dev)         |   | (off of main)            |
+----------------------+   +--------------------------+
           |                            |
        PR to dev                   PR to main
                                      and dev

---