グラフィックス ツールへの貢献 — MRTK3

  • [アーティクル]

パッケージを更新する

  1. リポジトリをフォークし、ブランチを作成します。 ブランチのネーミングはuser/username/featureの形を推奨しています。
  2. GraphicsToolsUnityProjectのサンプルプロジェクトをUnityでクローンして開きます。
  3. 必要な変更を加えます。 デフォルトでは、MRTK Graphics Tools パッケージ内のすべての編集は、Graphics Toolsパッケージに公開されます。 (サンプルを更新したい場合は、以下のセクションを参照してください)。
  4. あなたのブランチをあなたのフォークにプッシュし、プルリクエストを作成します。 プルリクエストに変更点の説明を追加してください。 画像やGIFの使用は歓迎されます。

パッケージ サンプルの更新

Unity のサンプルレコメンデーションで概説されているように、サンプルは Samples~ サブフォルダーの下に存在します。 「~」 文字を使用すると、 Samples~ フォルダーが Unity によってインポートされなくなります。 これは、パッケージ マネージャー経由でパッケージを含む場合に最適です。 ただし、パッケージ 内 のサンプルを更新する場合ではありません。

サンプルに変更を加える場合は、Unity プロジェクトのディレクトリ構造に対して一時的なローカル変更を行う必要があります。

  1. Unity で GraphicsToolsUnityProject を 開きます。 既定では、[サンプル] フォルダーは MRTK Graphics Tools パッケージに表示されません。 サンプルを表示するには、ファイル メニュー バーから [ウィンドウ] > [グラフィックス ツール] > [サンプルを表示する] を選択します。
  2. サンプルに必要な変更を加えます。
  3. 重要: 完了し、変更をコミットする前に、必ずサンプルを非表示にしてください。 [ウィンドウ グラフィックス ツール>] > ファイル メニュー バーから [サンプルを非表示にする] を選択します。

ヒント

サンプルを編集した後に ウィンドウ > グラフィックス ツール > の [サンプルを非表示にする ] メニュー項目を呼び出すと、git はすべてのサンプル ファイルが変更されたと考えます。 サンプルが非表示になると、実際に変更されたファイルが git で明らかになります。

ドキュメントの更新

API リファレンス ドキュメント

ドキュメントのコメントについては、次の 推奨 されるインライン スタイルを使用します。

/// <summary>
/// Class <c>Point</c> models a point in a two-dimensional plane.
/// </summary>
public class Point
{
    /// <summary>
    /// Method <c>Draw</c> renders the point.
    /// </summary>
    void Draw() {...}
}

概念説明のドキュメント

概念ドキュメントを更新するには、Mixed Reality ドキュメント リポジトリに移動します。

ヒント

グラフィックス ツールに関連する記事は、mixed-reality/mrtk-unity/mrtk3-graphicstools/ フォルダーにあります。

まず、Microsoft Learn のドキュメントへの投稿に関する次の推奨事項と、開発者向けドキュメントMixed Reality投稿するためのガイドに従います。