開発環境を用意する(コントリビューター)

この手順でできること

この手順を終えると、手元で dotnet build と、CI と同じ手順のテストが通ります。移植をする人は、Flutter の元の実装をローカルのクローンから引けるようになります。手順は5つで、手順4は移植をする人だけ、手順5は任意です。

環境がそろっていないと、CI と同じ結果が手元で出ず、PR を出してから落ちます。移植では Flutter の実装を見ながら書くので、引ける状態を先に作ります。

前提条件

Windows の PC を用意すること(CI は windows-latest で動く)
git を使えること

この手順で実行するビルドとテストに、SteamVR は要りません。SteamVR が要るのは、サンプルの実行と実機の確認です。実機の確認はテストの分け方で区別しています。

手順1: SDK を入れる

.NET の公式ダウンロードページから、.NET 10 SDK を入れる
次のコマンドで版を確かめる

dotnet --version

できた? dotnet --version が 10 で始まる版を返す。

できなかったら

9 以下が返るときは、dotnet --list-sdks で .NET 10 SDK の有無を確かめます。入っていなければ入れ直します。入っていれば、dotnet が選ぶ版(PATH の順序や global.json)を確かめます。

手順2: クローンしてビルドする

リポジトリをクローンして、リポジトリ直下でビルドします。

git clone https://github.com/sumx21t-3310/FloatSoda.git
cd FloatSoda
dotnet build

できた? dotnet build がエラーなしで終わる。

できなかったら

エラーメッセージの全文を読みます。SDK の版が合わないエラーなら、手順1に戻ります。それ以外のエラーで、自分の変更を加える前に出るときは、不具合を切り分けて報告するに進みます。

手順3: CI と同じ手順でテストする

PR を出す前に、CI と同じ手順を手元で通すことが規約です。CI の定義は ci.yml の Build と Test のステップで、次のコマンドと同じです。食い違うときは ci.yml に合わせます。次のコマンドを順に実行します。

dotnet build --configuration Release
dotnet test tests/FloatSoda.Rendering.Test --configuration Release --no-build
dotnet test tests/FloatSoda.Test --configuration Release --no-build

特定のテストだけを動かすには、--filter を使います。

dotnet test tests/FloatSoda.Test --filter "FullyQualifiedName~AlignmentTest.ComputeOffset"

--filter に一致するテストがないと、テストを1件も実行しないまま終わります。出力の合格件数が1以上であることを確かめます。

規約の全体はコントリビューターの規約から案内しています。

できた? 2つのテストプロジェクトが、どちらも成功で終わる。

できなかったら

テストが落ちたときは、落ちたテストの名前とメッセージを確かめます。自分の変更を加える前に落ちるなら、環境の問題か FloatSoda の問題です。不具合を切り分けて報告するに進みます。

移植をする人は手順4へ、それ以外の人は手順5へ進みます。

手順4: Flutter の元の実装を引ける状態にする(移植をする人)

Flutter の参照クローンの作り方は、flutter/flutter のリポジトリを参照してください。

できた? flutter/flutter のクローンが手元にあり、移植するウィジェットのファイルを開ける。

できなかったら

ウィジェット名が Flutter のクローンに見つからないときは、FloatSoda 独自のウィジェットの可能性があります。移植の手順は Flutter から移植するにあります。

手順5: Rider などの道具を足す(任意)

JetBrains Rider が入っていて、その MCP サーバーが使えるなら、C# のシンボル解決、リネーム、namespace の移動に使うと確実です。文字列置換は、ジェネリック制約、XML ドキュメントの cref、nameof を見落とします。

Rider がなくても作業は進められます。dotnet CLI と検索で続けます。道具を入れるかどうかは、自分で決めます。エージェントは、ソフトウェアを入れる前に、入れるものと理由を人間に確認します。

次はコントリビューターの規約です。

うまくいかないとき

ビルドやテストで出たエラーは、症状で行き先が分かれます。

症状	行き先
SDK の版が合わない	手順1
自分の変更を加える前にテストが落ちる	不具合を切り分けて報告する
自分の変更を加えたらテストが落ちる	落ちたテストの名前とメッセージを読み、変更を見直す