Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 3.51 KB

BranchGuide.md

File metadata and controls

45 lines (29 loc) · 3.51 KB

Mixed Reality Toolkit Branch guide

The Mixed Reality Toolkit uses multiple working branches within the project to manage the various components of delivery, these can be broken down to:


Release Branches

Release branches are frozen code linked to a specific released asset, the code held within these branches should match 1-1 with their corresponding asset. This ensures whether you download the asset or the code, there are no differences in the delivery.


Development Branches

Development branches relate to the current active and tested development state of the product. These should be considered "stable", however bugs may be introduced during the course of development.

  • htk_development - HoloToolkit development branch, active for fixes needed by existing customers.

  • Dev_Working_Branch - Obsolete. Persists for reference purposes as vNext is completed.

  • mrtk_development - Current Mixed Reality Toolkit (vNext) active development


Feature Branches

These relate to new components / features that are actively being developed for consideration to be included in the main development branch. These should not be considered stable and main contain breaking features, use at your own risk.

This list may not be up to date as development during the vNext beta is quite rapid, so simply use this as a guide and ask in Slack regarding future features / capabilities.

For example, here are some of the main area that are currently being worked on:

Other branches

Other branches are usually temporary or other experimental WIP. occasionally you will see "Staging" or "Stabilization" branches which are used temporarily for the Mixed Reality Toolkit release process