-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1407 from NeerajW/master
Adding Roadmap.md
- Loading branch information
Showing
3 changed files
with
54 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # Roadmap | ||
|
|
||
| ### Master branch | ||
| | Target Unity release | Release timeframe | Master release tag | Toolkit release features | | ||
| | --- | --- | --- | --- | | ||
| | 2017.2.0 | COMPLETED | v1.2017.2.0 | <ul><li>Updated master with Windows Mixed Reality support (xR namespace).</li><li>RI Dev_Unity_2017.2.0 into master.</li><li>Toolkit will work on both HoloLens and immersive headsets.</li><li>Windows Mixed Reality motion controller support.</li></ul>| | ||
| | 2017.3.0 | End Dec 2017 | 2017.3.0 | <ul><li>360 video player prefabs.</li><li>Scriptable foveated rendering prefabs.</li></ul>| | ||
|
|
||
| ### Dev_Unity_2017.2.0 branch - COMPLETED | ||
|
|
||
| | Target Unity release | Release timeframe | Branch release tag | Branch pre-release features | Status | | ||
| | --- | --- | --- | --- | --- | | ||
| | 2017.2.1 | Mid Oct 2017 | v1.Dev.2017.2.1 | <ul><li>Merge branch into master.</li></ul>| COMPLETED | | ||
|
|
||
| # Future work planning | ||
| - Automated build for MRTK-Unity. | ||
| - Unity packages for each release will be published to the Unity asset store. | ||
| - Unity packages for each feature area like Input/SpatialMapping will also be added to the release notes. More work needs to happen to ensure feature areas don't have cross dependencies. | ||
| - [Academy content](https://github.com/Microsoft/HolographicAcademy) will be updated with each major toolkit release. | ||
| - Updating API documentation using tools like Doxygen and not writing them manually. This is something we will work with all of you on. | ||
| - Update Wiki to host API documentation instead. | ||
| - Move reusable features from [Mixed Reality Design Labs](https://github.com/Microsoft/MRDesignLabs_Unity) project into toolkit. | ||
| - Improved samples and test cases | ||
|
|
||
| # Release cadence | ||
| ### Master branch | ||
| - **No direct PR's into master branch.** It will be locked and only merges from stable development branches will be taken. | ||
| - Exception will be major bug fixes on a case by case basis. | ||
| - Please use the [working development branch](https://github.com/Microsoft/MixedRealityToolkit-Unity/tree/Dev_Working_Branch) for daily feature work. | ||
| - [Working development branch](https://github.com/Microsoft/MixedRealityToolkit-Unity/tree/Dev_Working_Branch) will be snapshot every 3 weeks for stabilization into a separate branch. Working branch will still be open for contributions. | ||
| - That stabilization branch will be worked on for at least 1 week. | ||
| - Only bug fixes will be accepted in the stabilization branch before being merged into master. | ||
|
|
||
| - **Master branch releases** will align with **major Unity releases marking a release every 3 months**. Please read the [Unity roadmap](https://unity3d.com/unity/roadmap). | ||
| - Each release will be marked as a GitHub [release tag](https://github.com/Microsoft/HoloToolkit-Unity/releases). You can consume this release by: | ||
| - Using the zip file available in the release notes | ||
| - Unity packages available in the release notes | ||
| - Syncing to the specific git tag you would like to lock on. | ||
| - Release tag name convention: <Unity release major number>.<Unity release minor number>.Iteration number | ||
| - For example: For Unity version 2017.1.0 our release tag would be **2017.1.0.0** | ||
| - If we marked another release with the same Unity version: **2017.1.0.1** | ||
|
|
||
|
|
||
| ### Development branches | ||
| - Development branches are great for incubating features before they make their way into master. | ||
| - These branches can be feature work or experimental features. | ||
| - Development branches might not be on the same Unity versions as master. | ||
| - For being merged into Master the dev branch will have to follow the cadence laid out for master. | ||
| - Development branches might choose to mark releases on a faster cadence based on customer/project needs. | ||
| - Recommend marking a development branch tag every 2-3 weeks as needed to ensure stability before making up to master. | ||
| - Development branches might be deleted once merged into master. If more work is pending, it's ok to continue working in them. |