-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Branch Guide
This document describes the branching system used for the Mixed Reality Toolkit project.
The Mixed Reality Toolkit product utilizes release and development branches to provide customers with both a stable and a cutting edge code base.
The mrtk_release branch maps to the latest released code. This branch receives a new tag (ex: 2018.9.0-Beta) each time this branch is merged.
For customers wishing to use the most stable code, this is the branch to use.
The mrtk_development is the location in which active development occurs. All changes that are merged into this branch undergo a thorough code review process and require multiple approvals from the project maintainers.
Customers who are interested in contributing to the Mixed Reality Toolkit and / or are willing to help work through some instability as new features are refined, should use this branch.
The HoloToolkit product utilizes release and development branches to provide customers with both a stable code base as well as early access to the changes coming in the next release.
The htk_release contains the source code that matches the latest HoloToolkit product release (ex: 2017.4.3.0).
Please note that, in the future, this branch will be replaced by a branch called htk_release.
The htk_development branch is the location for active development on the HoloToolkit product. All changes that are merged into this branch undergo a thorough code review process and require multiple approvals from the project maintainers.
Feature branches are used to incubate large features prior to them being merged into the development branch. Each feature branch is to be named using the feature/name format, where name describes the feature. For example, feature/audioManager would be the location in which the audio manager feature is incubated.
All changes that are merged into this branch undergo a code review process and require at least one approval from a project maintainer. Once the feature is complete, a second review is performed prior to merging into the development branch. This second review requires two approvals.
Throughout the history of the Mixed Reality Toolkit project, a number of miscellaneous branches have been created and persisted.
- Obsolete/Dev_Working_Branch - This branch is obsolete and is persisted as a reference.
NOTE: This branch may be removed without notice at a future time.
- wikiFiles - This branch is the storage location for files presented in the Wiki section of this repository.
Over time, temporary branches are created. These branches are used for product stabilization and are generally deleted shortly after a release is merged and tagged.
Project Management
Contributing