Skip to main content

🌿 Create & Use a Tokens Studio Branch

Work safely in isolation and propose changes via PRs.

1) Create your branch​

  • Open Tokens Studio → Git → Create branch.
  • Use our Naming Conventions:
    • feat/<short-topic>_YYYY-MM-DD
    • fix/<short-topic>_YYYY-MM-DD

2) Switch to your branch​

  • Confirm the branch selector shows your branch.
  • Pull latest to ensure you’re up to date.
warning

Sometimes the plugin jumps back to main after operations. If tokens don’t look right, re-check the branch selector and switch back.

3) Make changes​

  • Edit token values/aliases.
  • Keep scope small and atomic (one intent per branch).

4) Commit & push​

  • Write clear commit messages (what/why).
  • Push your branch to GitHub.

5) Open a PR​

  • Open a PR to main following Git Workflow.
  • Request review from DS maintainers.

Next​

Create a Tokens Studio Branch

Now that you are setup, let create a branch. What to do first? As part of our guidelines, we advise you to always Pull the “main” most updated data from GitHub Pull.gif

Step by Step to create a new branch

Click on the “main” button

Create1.png

It will open a List of open branchs and itens. Select “Create new branch from”

Create2.png

After selection “Create new branch from” button, you will have a new level of the list. From the available item list, select ALWAYS “main”. We aren’t able to create branchs inside of other branchs!

Create3.png

When you select “main”, it will be displayed a new modal where you can define the Branch Name

Create4.png

After defining the name, insure you have applied the naming convention rules, click on the “Save” Button

Create5.png

Now you are ready to work on the branch that you created! Good job!

Create6.png

TO BE AWARE! Always make sure you are inside your branch when adding or changing tokens, sometimes the plugin jumps back to main