/
Git Branching Strategy

Git Branching Strategy

Owned by Mahesh Rajaram Gawali
Nov 15, 2024
2 min read

Main Branches

  1. master

    • Contains production-ready code.

    • All deployments to production are made from this branch.

  2. stable

    • Replica of the master branch.

    • Used as the base for feature development and patch branches.

  3. staging

    • Contains code prepared for testing.

    • Serves as an intermediate step before merging into stable and master.

  4. feature

    • Branch created from stable to develop new features.

    • Contains both stable code and new feature-specific changes.

  5. wip (Work In Progress)

    • Developer-specific branch created from feature for ongoing work on the current feature.

  6. patch

    • Branch created from stable to fix production bugs.

Branch Naming Strategy

  1. Feature Branch

    • Format: feature/{JIRA-Ticket-ID}

    • Example: feature/AI-101 (where AI-101 is the JIRA ticket ID).

  2. WIP Branch

    • Format: wip/{JIRA-Ticket-ID}/{Subtask-ID}

    • Example: wip/AI-101/Subtask-1.

  3. Patch Branch

    • Format: patch/{JIRA-Bug-ID}

    • Example: patch/BUGS-101 (where BUGS-101 is the JIRA bug ID).

Branching Model

1. Feature Development

  • Step 1: Create a feature branch from stable.

  • Step 2: If multiple developers are working on the feature, create individual wip branches from the feature branch.

    • Example: Two developers working on AI-101 will create wip/AI-101/Dev1 and wip/AI-101/Dev2.

  • Step 3: Daily workflow:

    • Every morning, developers pull the latest changes from the feature branch into their wip branches.

    • At the end of the day, developers push their changes from wip to the feature branch.

  • Step 4: After feature development is complete, create a merge request (MR) to the staging branch.

  • Step 5: Test the feature on staging.

    • If defects are found, fix them in the wip branch and merge the changes back into the feature branch, then push updated changes to staging.

  • Step 6: Once testing is successful, create MRs to merge the feature branch into both stable and master.

2. Patch Development

  • Step 1: Create a patch branch from stable for the reported bug.

  • Step 2: Complete the bug fix in the patch branch.

  • Step 3: Push the patch branch to staging for testing.

    • If defects are reported during testing, fix them in the same patch branch and push updates to staging.

  • Step 4: Once testing is successful, create MRs to merge the patch branch into both stable and master.

Workflow Diagram
will add after review completion

Related content