How to Create a Pull Request

This document will take you through the steps of creating a new pull request. Note: This document uses the Standard-Toolkit, but the procedure is the same for Extended-Toolkit.

  1. Requirements a) A copy of GitHub Desktop b) A copy of either Standard-Toolkit or Extended-Toolkit

Steps

Step 1

Clone a copy of either Standard-Toolkit or Extended-Toolkit with GitHub Desktop

Step 1: Cloning repository with GitHub Desktop

Step 2

Once cloned to your computer, open up GitHub Desktop, navigate to the repository then change the branch from main to alpha.

Step 2: Change branch from main to alpha in GitHub Desktop

(Note: You may see different branch names)

Step 3

In the same menu as before, click 'New branch', in the new window, create a name for your branch, making sure it is based on alpha.

New branch dialog in GitHub Desktop

Enter branch name in GitHub Desktop

Step 4

Once you have made your changes, press the 'Publish branch' button in GitHub Desktop

Publish branch button in GitHub Desktop

Step 5

Once you have published your branch, click 'Preview Pull Request'

Step 5: Preview Pull Request in GitHub Desktop

Step 6

Once you have clicked 'Preview Pull Request', the following window will appear

Step 6: Create pull request window in GitHub Desktop

Please ensure that alpha is selected before clicking 'Create pull request'

Step 7

Once you have clicked 'Create pull request', GitHub Desktop will launch your default web browser. From there, please type in your notes, then assign either @Smurf-IV, @Wagnerp, @giduac, @tobitege, @KamaniAR or @lesandrog before clicking 'Create pull request'. From there, we will review your changes, and sometimes ask you to make changes if necessary. Once the changes are merged, please then delete your branch to avoid "stale branches".

Step 7: Pull request details in web browser

Animation

Animation: Creating a pull request in GitHub Desktop

Additional Notes

  1. Please remember to always update Changelog.md with any changes that you have made. This is located in Documents\Help\Changelog.md.

  2. We ask you to provide a build report when submitting a pull request. This allows us to verify that there are no errors within the code. To do this, simply execute run.cmd from the root directory. Choose option '4' -> '1'. Once completed, it should show something like this:

    Build log example output

    Simply take a snippet of the log, then paste it into your pull request description.

Note: As of version 100, we have introduced workflows. Each time a pull request is updated, it will automatically compile the code.