Skip to content

dev contributing

Akihiko Shirai edited this page Oct 31, 2020 · 2 revisions

id: contributing title: 貢献

このページでは、Hubsプロジェクトに貢献したいと考えている人が貢献できる事の概要を紹介しています。 共有3Dスペースを介したコラボレーションとコミュニケーションを可能にするというプロジェクトの使命に沿った外部からの貢献を歓迎します。 我々は共有された3D空間を通じた共同と交流を可能にするというプロジェクトの使命を支援してくださる外部の貢献者を歓迎いたします。 Hubsへの貢献方法と、プラットフォームを構成するサポートプロジェクトについての情報は、こちらでご覧いただけます。

貢献者は、プロジェクトの 行動規範 に従い、プロジェクトとそれに取り組む人々を尊重することが期待されています。

以下のGitHubプロジェクトはHubsプラットフォームの一部であり、これらの貢献ガイドラインによって管理されます。

クイックスタート

我々は、以下に示しているHubsプラットフォームへの様々な方法での貢献を歓迎します。 全ての貢献はプロジェクト管理者による承認の対象となるためご注意してください。 Hubsに貢献することに興味を持つ人は、一般の Hubs Discordサーバー に参加し(必須ではありません)。質問やプロジェクトで行われる作業についての議論等、開発チームへの連絡をご検討してください

💻コードの貢献

Hubsには、サーバー上の共有ルームに複数のユーザーが接続できるクライアントサーバーアーキテクチャがあります。 Hubsクライアントに貢献したい場合は、 Readme の指示に従って開始してください。 ネットワーキングやインフラストラクチャに貢献したい場合は、 reticulum または janus リポジトリを参照してください。 あなたがSpokeのコードに取り組むことに興味があるなら。 Hubsルーム用のカスタム環境を作成するために使用される3Dエディタは、 Spoke リポジトリを参照してください。

Hubsの内部的な仕組みとその背後にある構成上の決定に関する詳細については、こちらをご覧ください。エンジニアリングリーダーのLead Greg Fodorのプレゼンテーションをご覧下さい。 his presentation on the Mozilla Hubs Code Base

未解決の問題にはタグがつけられます。 修正したいバグや機能のリクエストを見つけた場合は、ケースにコメントしてください。調査中であることがわかります。 我々はあなたがコードベースでの作業を始めやすくするため、他のケースとは比較的に簡単なケースには'good first issue' タグをつけています。

コードをHubsプロジェクトに提供する手順:

  1. 貢献したいリポジトリのクローンを作成し、ローカルで実行する
  2. 修正したい問題または改善点を見つけてください - 問題に関するコメントを入力して、問題に取り組んでいることをお知らせください。
  3. バグを修正! ローカルの設定で変更をテストし、修正について質問がある場合や別の意見が必要な場合はお知らせください。
  4. コードレビューのためにPRを送信してください。チームの誰かが調査を行い、フィードバックを提供します。 必ずフォローアップしてください! レビューに残した質問やコメントに応答しないことで放棄したと思われる場合は、PRを終了します。 PRが新しい機能を追加する場合は、「What's New」タグのリクエストを検討してください。 「What's New」タグはPR本文に記載されたテキストと最大1枚までの画像がHubsのウェブサイトに追加されます。 特にGIFは高く評価されています! このプルリクエスト は、「What's New」タグの使用方法の例を示しています。
  5. おめでとうございます! 🎉あなたはインターネットをオープンでアクセス可能な場所にするというMozillaの使命に貢献しました!

🐛問題の提出と機能のリクエスト

プラットフォームに関するバグ、機能リクエスト、質問を報告することで、チームは私たちが行っている作業に優先順位を付け、Hubsを改善することができます。 我々はユーザーが提出した問題を歓迎し、Githubの組み込みの問題追跡をバグ報告プロセスに使用します。

  • バグを報告する場合は、バグを見つけたときに使用していたオペレーティングシステム、デバイス、ブラウザに関する情報を含めてください。 Example: Seen on Windows 10 with Firefox 66.0.5 on Oculus Rift

  • 詳細は多いほど良いです! 情報があることで、私達は複数の異なるブラウザまたはデスクトップとモバイルの両方でバグを再現できる事を知ったりする事ができる等に役立ちます。

  • 適切なスクリーンショットも大歓迎です📷

インバウンドの問題はタイムリーに送信されるため、問題への対応とタグ付けに最善を尽くします。 私達は最善を尽くして、問題への対応とタグ付けを直ぐ行えるように取り組んでいます。 バグは次の表に従って優先順位が付けられます。

優先 基準
P0 迅速な対応が必要です。 多くのユーザーと、他のユーザーと部屋に接続するコア製品機能を使用するユーザーに影響を与えます。 VRヘッドセットを備えたHubsルームには誰も入室できません
P1 可能な限り迅速に対処します。 多くのユーザーと、共通の製品機能を使用するユーザーの能力に影響します。 回避策は難しいか利用できません。 テレポートは、Oculusブラウザーを使用するQuestのユーザーには機能しません。
P2 可能であれば調査します。 一部のユーザーに定期的かつ軽度に影響するか、まれに見られる再現困難な障害であるか、簡単な回避策で修正されます。 カメラモードのロビーカメラでは、iOSから共有された絵文字は表示されません。

特定のルームで10分後に切断されたユーザー報告があります。 しかし誰もそれを経験していないし再び入るために更新することができます
P3 P2のバグが修正された後、可能な場合に調査します。 少数のユーザーに影響を与え、簡単な回避策を使用して、互換性を損なうことなく一貫した方法で影響を与えます。 多くの場合、スタンドアロンVRヘッドセットはユーザーリストにモバイルとして表示されます。 更新すると修正されます。

🎨3Dアート

あなたが3Dアーティストで、Hubsで行っていることをサポートしたい場合。 Creative Commons ライセンスの下でコンテンツの作成とリリースを検討するか、 Spoke Web editor を使用してシーンを作成し、それらをリミックス可能な環境としてリリースすることを検討してください。 ポリゴン数が少なく、Web上で適切に実行されるように最適化されたコンテンツは大歓迎です。 特に、幅広い体験を捉えたシーンを望みます。

📜ドキュメント

Hubsのドキュメントは、プロジェクトの GitHub Hubs Wiki セクションでホストされています。 Spokeのドキュメントは、Wikiの修正や追加ページに貢献するための GitHub Spoke Wiki でホストされています。 提案されたコンテンツを対応するリポジトリに提案として問題を提出してください。それをレビューし、うまく見えたらwikiに追加します!

🌐ローカリゼーション

Hubsは現在en-USのみですが、ローカリゼーションの取り組みについて私たちと協力したい場合は、GitHubの問題を通じて提案を送信してください。そこから協力します。

🦆一般的なヘルプ

私たちはコミュニティーの力を信じ(結局、これを構築しているのはそのためです!)、すべての形式のサポートがここで概説したものからもたらされるわけではないことを知っています。 私たちの Discordサーバー に参加して、私たちとチャットし、参加方法について聞いてください!

まずはじめに

ユーザーガイド

Spoke 関連

クリエイター向け

開発者向け

Hubs Cloud

Hubs Cloud AWS

Hubs Cloud DigitalOcean

日本語追加ドキュメント

Clone this wiki locally