どんな貢献が助かるか

どの貢献から始めてもよい

貢献は5種類あります。ドキュメントを書く、動作検証をする、コードを作る・直す、機能を提案する、エージェント向けの skill を書く、の5つです。コードを書かなくても関われます。どの種類から始めてもかまいません。

いま何が足りないかは、このページには書きません。状況は変わるので、GitHub の Issue のラベルで探せるようにしています。手が足りない Issue には help-wanted、始めやすい Issue には good-first-issue が付いています。探し方は Issue・PR・マイルストーンの読み方にあります。

気になる種類の節へ進んでください。

ドキュメントを書く

分かりにくかった箇所や、直したい箇所を docs/ 配下のファイルで直す貢献です。ドキュメントは docs/ から GitHub Wiki と公開サイトに同期されるので、Wiki 側を直接編集しても同期で上書きされます。

要る条件は次のとおりです。

Git と GitHub の基本操作ができること
書く規約を読んでおくこと

規約の場所はコントリビューターの規約にあります。

動作検証をする

自分の環境で動かして、結果を報告する貢献です。「落ちた」「落ちなかった」の報告がいちばん助かります。SteamVR は環境で挙動が大きく変わるためです。ここでの「落ちなかった」は、作例の確かめる点をすべて通ったことを指します。異常終了しなかっただけの報告とは区別します。落ちなかった報告は、その環境で作例が動いた記録になります。

要る条件は次のとおりです。

HMD と SteamVR のある環境を用意すること

報告には、HMD、GPU、プラットフォーム、モード、日付を添えます。

報告の形は不具合を切り分けて報告するにあります。

コードを作る・直す

ウィジェットなどのコードを足したり、バグを直したりする貢献です。現段階でコアに受け入れるのは、プリミティブ層のウィジェットです。public API の追加・変更や、observable behavior の変更は、着手前に Issue を立てます。

要る条件は次のとおりです。

手元でビルドとテストを通せる環境を用意すること

次のページから始めます。

機能を提案する

作ってほしい機能や、設計の変更の案を出す貢献です。提案は Issue で始まります。public API を追加する場合は、受け入れ条件があります。

書き方は提案を書くにあります。

エージェント向けの skill を書く

繰り返す作業を、エージェントに任せられる形にする貢献です。リポジトリの skill の正本は .agents/skills/ にあります。

足す・直す手順は skill を足す・直すにあります。

次に読むページ

選んだ種類ごとの行き先は、各節の末尾に書いたとおりです。手が足りない Issue を探すときは、Issue・PR・マイルストーンの読み方を開きます。出す前の規約はコントリビューターの規約にあります。