MRTK2 への貢献

Mixed Reality Toolkit (MRTK) は、コミュニティからのコントリビューションを歓迎します。 すべての変更 (大小) は、 MRTK コーディング標準に従う必要があります。 変更のレビュー時の遅延を回避するために、開発時にこれらを理解していることを確認してください。

ご不明な点がある場合は、Slack の mixed-reality-toolkit チャンネルからご連絡ください。 自動招待センダーを使用して Slack コミュニティに参加することができます。

申請プロセス

開発者が新しいイシューの作成から始めて、Mixed Reality Toolkit に貢献できるようにするためのいくつかのパスを提供します。

[問題の種類] を選択する

ここから、以下を報告します。

  • バグ レポート - Mixed Reality Toolkit コンポーネントの 1 つに関する機能の問題
  • ドキュメントの問題 - Mixed Reality Toolkit のドキュメントに関する問題
  • 機能要求 - Mixed Reality Toolkit の新機能の提案

機能要求の提案

新しいMixed Realityツールキット機能を要求する場合は、解決すべき顧客の利益/問題を文書化することが重要です。 送信された機能要求は、GitHub でレビューおよび議論されます。 多くの顧客にとって作業が有益なものとなるよう、個々の機能提案について、オープンで建設的な議論を行うことを奨励します。

機能を修正する必要を回避するために、レビュー フェーズ中に機能の開発を開始しないことをお勧めします。 多くの場合、コミュニティ レビュー プロセスによって 1 つまたは複数の問題が明らかになりますが、その問題のゆえに、提案された実装の大幅な変更が必要になる場合があります。

Note

既にバックログに存在している事項に関して作業を行う場合は、その作業項目を提案として使用できます。 タスクの完了に向けてあなたが作業中であることがメンテナにわかるよう、タスクに関するコメントも残すようにしてください。

貢献プロセス

作業を開始するには、次の手順に従います。

  1. リポジトリをフォークします。 ページの右上にある [フォーク] ボタンをクリックし、フローに従います。
  2. (main ブランチからの) フォークにブランチを作成すると、提出の準備ができるまで変更を隔離しておくことが容易になります。 リリース安定化期間中のバグ修正は、最新の prerelease/* ブランチから探します。 新しい機能は常に main に入れる必要があります。

Git ワークフローを初めて使用する場合は、GitHub からこの概要をチェックします。

バグ修正または機能を追加するときは、次の手順に従います。

  1. バグ修正または機能を実装します。 MRTK の構築と展開の手順については、「 HoloLens および WMR デバイスへの展開」を参照してください。 コーディングのガイドラインに従うことを忘れないでください。
  2. 機能を追加する場合は、その機能の例を示すサンプル シーンも追加します。
  3. 試験的な機能を追加する場合は、テストとドキュメントを記述する必要はありません。 代わりに、実験的な機能のガイドラインに従ってください。
  4. バグ修正/機能を検証するためのテストを追加します。 テストを記述して実行する手順は UnitTests にあります。
  5. ドキュメントのガイドラインで説明されているように、コードと機能のドキュメントが作成されていることを確認します。
  6. コードがすべてのプラットフォームで意図したとおりに機能することを確認します。 サポートされているプラットフォームの一覧については、 リリース ノート を参照してください。 Windows UWP プロジェクトの場合、コードは WACK 準拠である必要があります。 これを行うには、Visual Studio ソリューションを生成し、プロジェクトを右クリックして [ストア]>[アプリ パッケージの作成] を選択します。 画面の指示に従って WACK テストを実行します。 すべて成功したことを確認します。
  7. プル要求を行うときは、プル要求に関する記事の指示に従います。