夜風のMixedReality

xRと出会って変わった人生と出会った技術を書き残すためのGeekなHoloRangerの居場所

MRTKのGitHubに提供する。 その①

 先日MRTKv2ExaplesのMaterialGalleryのサンプルシーンを基にsliderでshaderの機能をHoloLens実機で確認できる機能を作りました。

redhologerbera.hatenablog.com

 Shaderはオブジェクト自体の見た目に直結しているためHoloLens実機で変化を確認できるこの機能は、ほかの開発者へもぜひ共有したいため、今回はMixedRealityToolKitのGitHubへ自分の変更を提供します。

 といってもこのようなGitHubへの提供は初めてのためまずはドキュメントを見て勉強しながら行っていきます。

〇提供の流れ

microsoft.github.io

 によると  

  Mixed Reality Toolkit(MRTK)は、コミュニティからの貢献を歓迎します。 すべての変更は大きなもの小さなもの限らずMRTK coding standardsに基づいている必要があります。  そのため、変更をレビューする際の遅延を避けるために開発中にこれらに精通していることを確認してください。

原文:The Mixed Reality Toolkit (MRTK) welcomes contributions from the community. All changes be they small or large, need to adhere to the MRTK coding standards, so please ensure you are familiar with these while developing to avoid delays when the change is being reviewed. If you have any questions, please reach out on the mixed-reality-toolkit channel on Slack. You can join the Slack community via the automatic invitation sender.

とあります。

・イシュー提出プロセス

 すべてはイシューを作成することから始まるようです。

github.com

 MRTKのGitHubへの新しいイシューは上のリンクから行えるようです。

 イシューには3種類あり、開発者が提供する機能に合わせて選ぶことができます。

・Bug report

  こちらはその名の通りバグに関する報告です。

・Documentation Issue

  こちらはドキュメントが間違っている場合や情報が抜けている場合等に行う報告です。

・Feature Request

  こちらはMRTKに関するアイデアを提供する報告です。

 MRTKの機能に関するリクエストを行う場合ユーザーの利益と現状の解決すべき問題を文章化することが重要になります。

  リクエストが送信されると、GitHubで機能のリクエストが確認および議論されます。

  その変更が多くのユーザーにとって有益であることを証明するために、オープンな場での議論を奨励します。

 機能を作り直す必要が発生する場合を回避するために、通常、レビュー段階では機能の開発を開始しないことをお勧めされています。

  多くの場合、コミュニティのレビュープロセスにより、提案された実装の大幅な変更が必要になる可能性のある問題が明らかになります。

・提供のプロセス

 1.リポジトリをフォークします。GitHubページの右上にある[フォーク]ボタンをクリックして、フローに従います。    2.フォークにブランチを作成し(mrtk_developmentブランチから)、送る準備が整うまで変更を簡単に判別できるようにします。Gitワークフローを初めて使用する場合は、Githubからこの紹介をご覧ください。

 バグ修正または機能を追加するときは、次の手順を実行します。

  1. バグ修正または機能を実装します。 MRTKのビルドとデプロイの手順は、BuildAndDeployにあります。コーディングガイドラインに従っていることを確認してください。

 2.機能を追加する場合は、機能を示すサンプルシーンも追加します。

   3.実験的な機能を追加する場合、テストとドキュメントを書く必要はありません。代わりに、実験的な機能のガイドラインに従ってください。

 4.テストを追加して、バグ修正/機能を検証します。テストの作成と実行の手順はUnitTestsにあります。

   5.ドキュメントのガイドラインの説明に従って、コードと機能がドキュメント化されていることを確認します。

 6.コードがすべてのプラットフォームで意図したとおりに機能することを確認します。サポートされているプラ​​ットフォームのリストについては、リリースノートを参照してください。 Windows UWPプロジェクトの場合、コードはWACKに準拠している必要があります。これを行うには、Visual Studioソリューションを生成し、プロジェクトを右クリックします。 [ストア]> [アプリパッケージの作成]。プロンプトに従い、WACKテストを実行します。それらがすべて成功することを確認してください。

 7.プルリクエストを行うときは、プルリクエストの手順に従ってください。

 

  といった流れになるようです。