Skip to main content

Design Branch

đź“Ś If you have any questions shoot us an email or join us on Discord! đź’ś

Overview​

System Design Branches overview

Create branches of your project to manage changes to your system efficiently, transparently, and collaboratively.

Multiplayer automatically creates a “main” branch for each new project. Your current branch is indicated at the center of the top navigation bar.

By clicking on the branch name, a side panel will open a list of all the branches within the project.

When to use the "Main" Design Branch​

If you’re looking to make simple and quick changes to your project's Platform, Components, Notebooks, etc. which everyone in your team is aligned on and should see immediately, you can directly edit the “main” branch.

You should create a new branch when you want your team to:

  • Review and provide input on your plans before you implement them
  • Enable parallel development or experimentation of a new feature
  • Evolve or refactor portions of your system architecture
  • Fix a bug that will affect multiple components in your system architecture

Create a new Design Branch​

New branch.png

  • Open your project
  • Click “Create a design branch” in the top right corner
  • Name the branch and select the type (Feature / Change / Bugfix)
  • Click “Create”

Now you can edit your Platforms, Notebooks, Sketches, Environments, etc.

Switch between Design Branches​

Switching between System Design Branches branches

  • Open your project
  • Click on “main” in the top navigation bar
  • In the sidepanel that opens, you'll see a full list of all the Design Branches within the project
  • To open an existing Design Branch:
    • Click on the name of the Design Branch in the list
    • Click the ">" arrow button to open the full information about that branch. Click "Switch to this design branch"

🔑 Pro Tip: The name of the design branch you're currently viewing will appear in the very top navitation bar.

Comment on a Design Branch​

  • Open your project
  • Click on “main” in the top navigation bar
  • In the sidepanel that opens, you'll see a full list of all the Design Branches within the project
  • To open an existing Design Branch and select the "Comments" tab
  • Type your comment and hit enter

Request a Design Branch Review​

Check the System Design Reviews doc for more information on how to ask your team to review your Design Branch.

Merge a Design Branch​

(1) You don’t need team input

  • Click the drop down arrow next to “Request a Review”
  • Select “Merge”
  • Review your changes and click “Merge”

(2) You need team input

Rename or Delete a Design Branch​

  • Click on “main” in the top navigation bar. If you’re currently viewing a design branch, this is where you will see the name of the new branch
  • In the design branch right-side panel select your branch
  • Click on the “…” ellipsis button
  • Select your desidred action

Next Steps​

You did it! What’s next?