Contributing to the Kanda SDK is an excellent way to improve the toolset and help yourself and other teams to make great training simulators. This guide outlines the general best practices for contributing to the package.

1. Clone the package repository

Start by cloning the specific Kanda SDK package repository you wish to work on to your local machine.

git clone git@bitbucket.org:kandagames/io.kanda.sdk.git

2. Add as a Local Package in Unity

Add the cloned repository as a local package in Unity. This will override the package that was added from the package registry, allowing you to work on it within the context of your Unity content project.

Open Unity and navigate to Window > Package Manager. Click the + button and select Add package from disk.... Choose the package.json file from the cloned repository.

3. Create a Branch

Create a new branch for your feature or bug fix. Use a descriptive name for your branch to clearly communicate the purpose of your changes.

If you track work using Jira, it can be helpful to prefix the issue name, such as feature/SDK-123_my-feature.

git checkout -b feature/SDK-123_my-feature

We prefer short-lived feature branches, but you should make sure your changes satisfy the Definition of Done before submitting for review.

4. Write Code

Write clear, focused and well-documented code. Ensure your code follows the established package layout, coding standards and design principles of the Kanda SDK.

We prefer a data-oriented approach wherever it is possible and practical to implement.

5. Include Tests

Whenever possible, include automated tests for your changes. This helps maintain the integrity of the SDK and ensures that new features or fixes do not introduce regressions.

6. Write docs

Make sure the new functionality has proper documentation in the form of C# XML docs and a user manual.

6. Commit Changes

Make atomic commits with clear, descriptive commit messages. Each commit should represent a logical unit of work.

git commit -m "Add feature to support X"

7. Push to remote

Push your changes to the remote repo.

git push -u origin feature/SDK-123_my-feature

8. Create a Pull Request

Create a pull request (PR) to merge your changes into the main branch. Ensure your PR description clearly explains the purpose and context of your changes. Include any relevant issue numbers.

Once the PR is live, you will be able to review automated test results from the CI pipeline.

9. Respond to Feedback

Engage with any feedback or requests for changes from the maintainers. This collaborative process helps ensure that your contribution meets the quality standards of the Kanda SDK.

10. Follow Up

After your PR is merged, make sure to follow up on any post-merge feedback or issues. Stay engaged with the community and continue contributing to improve the SDK.

11. Release new package version

When reaching a checkpoint of sufficient new functionality, an updated package can be released. See the release guidelines for detailed information about how to do this.