SDK Contribution Guidelines

When it comes to contributing to the SDK there are viable options here as there is moderation. Before contributing to the SDK there is a process you should follow as outlined below...

Step 1: Preparing the SDK

First, you'll need to setup this SDK somewhere on your computer. By following the steps below it'll teach you how.

• Begin by creating a fork from this repository by selecting the Fork button on GitHub in the top right.
• Secondly, clone your newly forked repository to somewhere on your computer.
• Then run through the Unity Setup if you haven't done so already. But instead of installing the SDK via Add package from git URL... do it from the Install package from disk... and select the package.json file from your cloned fork.

Step 2: Creating or Finding an Issue

In this step this is where you can choose between finding an existing feature request or bug report and fix them, or creating your own feature request or bug report and fixing those. While this step isn't necessarily needed it's highly recommended as it's provides insights into what feature / bug you are working on.

• Begin either looking through all the Issues and choosing a feature request to fulfil or a bug report to fix. Or open your own Feature Request or Bug Report templates in Issues to then tackle yourself.
• If you are creating a new Feature Request or Bug Report then ensure to fill out the required details by the template, as it will help others understand what your goal is.

Step 3: Create a Branch

After choosing one of the options above, it's necessary to make a branch from your forked repository. This is to ensure no direct changes are made to the develop branch which might end up breaking something.

• Begin by creating a branch, it's necessary to use a name that easily describes the feature or bug you are working on. Keep it clean and simple for everyone to understand, but you'll be referring this branch back to the issue you created or chose earlier.

IMPORTANT

It's also important to separate your branches for each feature or bug you are working on. DON'T work on multiple features and bugs in one branch.

Step 4: Committing Changes

After coding new functionality or fixing bugs, remember to commit your changes as you go. These can be seen as a 'saving' point for each point in your coding timeline. While making commits, make sure they follow the standard below:

• Make sure commit messages are clear and concise that explain any changes made.

Step 5: Testing Changes

Once you have either added the feature or fixed a bug, it's important to test your changing in order to make sure nothing else has been affected in the process. While there isn't really a process towards checking certain things, it's good practice.

Step 6: Submitting a Pull Request

Finally, after all the following steps are completed - you can finally make a pull request for these changes to be merged into the official SDK. Once doing so, you will be added to the contributors list with what you have contributed to the SDK. Follow the steps below in order to ensure a successful pull request.

• Begin by pushing your branch(s) to your forked repository on GitHub.
• From there, submit a pull request to the develop branch of this SDK.
• As you are submitting your pull request. You need to describe the changes, link to the related issue you have either chosen or opened, and mention any important considerations or steps required for testing.

WARNING

Make sure it is the develop branch and NOT the release branch.

INFO

Once the pull request is checked and tested by someone, and something doesn't add up. They will get back to you in your pull request letting you know why they haven't merged it in, and what changes you need to make in order for them to be.