Skip to main content

Pull + Push + New Pull Request Guidelines

Actions we must not forget!

  1. Pull action . Tokens Studio Once Token Studio has load, we advise to ALWAYS to Pull from GitHub. This will ensure that we are always working with the latest version of the “main” and we don't run the risk of "losing" work that will overlap with the changes pulled.

Push_Animation.gif BE AWARE If you are going to create a new branch, insure that you always Pull the most recent data on the “main”

  1. Push action . Tokens Studio The Push action allows you to send and save all the changes we've made or created in the branch to GitHub. Push action can be done as many times as necessary during the day or until the task is complete.

Step by Step to create a new branch

As soon you see a “blue circle” signpost on the action button, you can PUSH to GitHub and “save” all the work done until that moment.

Pull_Animation.gif

As soon as you click on "push" a pop-up will appear with various fields. The most important and relevant at this stage is the "Commit Message" field. The development teams use what is described in this field to understand the information sent and review the branch.

BE AWARE When filling in the "Commit Message" field, please ensure that the guidelines of the "Names Conventions Guidelines" have been applied.

Pull5.png

Success! The Push is done. A new message appears. If it's your last push of the day and everything is finalised, click on the "Create Pull Request" button. ( please see bellow information about “New Pull Request Guidelines” ) However, you should only make a "New Pull Request" once per branch or per day.

Pull.png

If the signpost remains after the "Push" has been carried out, it means that there are new updates coming from the "main" and that they must be carried out to keep everything up to date on the branch. To do this, a new pull must be made. A new pop-up will appear with a list of tokens that will be updated.

Pull2.png

Done! Everything is saved and updated. You can continue with your tasks or move to the next step of the process: create a NEW PULL REQUEST.

  1. New Pull Request Guidelines Creating a New Pull Request means that we're creating a new request in GitHub that will ask the Developers to review everything we've done on a particular branch and merge it into the "main".

Before requesting a New Pull Request, we always have to Push it through Token Studio. This action means that we have synchronise everything in a new request on GitHub.

There are 2 ways to make a New Pull Request:

Use the Tokens Studio Flow

Use GitHub dire

Let's make a New Pull Request! Once everything has been finalised, we must carry out the Push action. If you still have questions about Push, please find out more here

New-Pull_animation.gif

Request a New Pull Request from Github! It may happen that we've already done Push and we need a New Pull Request because everything is finalised. To do this, simply visit the Branches page on Github If you still have questions about Push, please find out more here

New Pull Github.png

At the end of the Push process, a message will appear indicating that the push to GitHub was successful. There is a blue button: "Create Pull Request" which you must click to proceed.

New Pull6.png

Once you have identified the branch you want to request the New Pull Request for, click on the "..." button on the right-hand side of the branch line. A dropdown will open with various actions that you can apply to the branch.

In this case we need to click on the "New Pull Request" button

New Pull Github 4.png

After clicking on the blue button: "Create Pull Request", a browser window will open that will take you directly to GitHub. On this page you'll have access to information about the New Request. There is a green button that you must click to create the pull request: “Create pull request”

New Pull7.png

After clicking on the button: "New Pull Request", a page will open showing all details of the branch and some fills to open a pull request. If during the Push process you didn't describe the impact of the changes, we strongly recommend that you fill in the details of what this new Pull brings as changes in the "Add a description" field. By filling in this information, the developers who will be reviewing the branch will have a context about the branch and it will be easier to carry out the review process.

There is a green button that you must click to create the pull request: “Create pull request”

New Pull Github 5.png

And that's it! Simple! After creating the Pull Request, the development teams will review the information on your branch and if everything is OK, they will merge the branch into the main file.

New Pull9.png

And that's it! Simple! After creating the Pull Request, the development teams will review the information on your branch and if everything is OK, they will merge the branch into the main file.

New Pull Github 6.png

If you need to see the full list of requests in GitHub, just click on the navigation item: Pull requests

VERY IMPORTANT Each Design System has is own rules to make the New Pull Request. Please see which case is aligned with your work

How to identify a New Pull Request type In the Commit Message field you will need to fill the information so the developers can understand what type of Pull will be. It's imperative that there is always consistency in the signpost of the Pull Requests. You can see below the various types of Pull Requests and what they represent.