このリポジトリには、create.roblox.com/docs にある作成者ドキュメントのソース コードが保存されています。
注: 現在、リポジトリにはガイド、チュートリアル、教育コンテンツ、およびエンジン API リファレンスが含まれています。コードサンプルは近日公開予定です。
GitHub のコントリビューション プロセスに慣れていない場合は、「プル リクエストについて」と次のビデオを参照してください。
ドキュメントに問題が見つかり、プル リクエストを送信したくない場合は、Roblox 開発者フォーラムに報告してお知らせください。
Roblox 作成者ドキュメントへの追加は、より大きな全体の中に収まる必要があります。言い換えれば、包括的で正確でよく書かれたブログ投稿や技術的なホワイトペーパーであっても、Web サイトに掲載されない可能性があります。
一般的に、当社は既存の標準に準拠し、さまざまなエクスペリエンスやユースケースに適用されるコンテンツを探します。たとえば、 「レーシング ゲームのスピードメーターを作成する」のようなページよりも、 「ユーザー インターフェイスの構築」のようなページを好みます。より専門的なガイドを Roblox 開発者フォーラムに投稿することを検討してください。
レビューのためにプル リクエストを送信するときは、次のことに同意する必要があります。
この投稿は全体または一部が私によって作成されたものであり、私はこのリポジトリのオープンソース ライセンスの条件に基づいて投稿する権利を有します。
私は、この貢献とその記録が公開され、無期限に維持され、このリポジトリのオープンソース ライセンスの条件に基づいて再配布できることを理解し、これに同意します。
私の知る限り、提案された変更はすべて正確です。
単一のファイルのみを変更する単純な変更の場合は、GitHub の Web ベースのエディターを使用します。
content/en-us/でファイルを見つけて、 「このファイルを編集」をクリックします。
「このリポジトリをフォークする」をクリックします。
変更を加えて、 「変更をコミット...」をクリックします。
変更内容を説明するコミット メッセージを入力し、 [変更の提案]をクリックします。
ベース リポジトリがRoblox/creator-docsであり、ベース ブランチがmainあることを確認します。変更内容に問題がないことを確認し、 「Create pull request」をクリックします。
最後に、プル リクエストの説明に詳細を入力し、 [プル リクエストの作成]をクリックします。
複数のファイルに関わる大規模な変更の場合は、ブラウザーで実行できる Visual Studio Code ベースのよりフル機能のテキスト エディターである github.dev をお勧めします。
リポジトリをフォークします。
フォークを参照しているときに、 を押します。 github.dev を開くためのキー。
[ソース管理]メニューで、 [...] > [ブランチ] > [ブランチの作成...] をクリックします。
ブランチに名前を付けて、 [ブランチに切り替え]をクリックします。
Explorerメニューを使用してcontent/en-usで更新するファイルを見つけ、必要な変更を加えます。
[ソース管理]メニューで、変更に問題がないことを確認します。
コミット メッセージを追加し、 [コミットとプッシュ]をクリックします。
新しいブラウザー タブで、github.com/Roblox/creator-docs に移動します。
[比較とプルリクエスト]をクリックします。
ベース リポジトリがRoblox/creator-docsであり、ベース ブランチがmainあることを確認します。ヘッド リポジトリはフォークおよびブランチである必要があります。
最後に、プル リクエストの説明に詳細を入力し、 [プル リクエストの作成]をクリックします。
あるいは、github.dev のGitHubまたはGitHub Pull Requestメニューを使用して、プル リクエストを送信することもできます。 github.dev の使用に関するドキュメントについては、「GitHub コードスペース」を参照してください。
このリポジトリは非常に大きいため、可能な限りオンライン オプションを使用することをお勧めします。ただし、一般的な GitHub ワークフローにすでに慣れており、オフライン テキスト エディターを使用したい場合は、ドキュメントに貢献するための基本的な手順を次に示します。
Git と Git LFS をセットアップします。あるいは、GitHub Desktop などの Git クライアントをインストールします。
このリポジトリをフォークします。
フォークのクローンを作成します。
リポジトリのルートに移動します。
新しいブランチを作成します。
必要な変更を加えます。
コミットしてフォークにプッシュし、このリポジトリのmainブランチに対してプル リクエストを送信します。
詳しい手順については、CONTRIBUTING.md を参照してください。
Roblox ドキュメントには、次の 3 つの主要なドキュメント タイプがあります。
content/en-us/ の.mdファイル内の概念ガイドとタスクベースのガイド
ガイドでは、最終結果について過度に規範的なものにすることなく、機能やワークフローについて説明します。概念と機能を紹介し、さまざまなツールやその他のアプローチを使用して実行できるタスクについて説明します。
ガイドは、実際の実際の使用例、画像、コード スニペット、図から大きな恩恵を受けます。ほとんどのタスクベースのコンテンツには、番号付きリストが含まれている必要があります。
content/en-us/reference の.yamlファイル内の API リファレンス ドキュメント
API は完全に参照コンテンツであり、機能の説明を使用し、必要に応じてガイドにリンクする必要があります。他のコンテンツ タイプよりも、参照コンテンツは簡潔かつ直接的である必要があります。プロパティ、メソッド、イベント、コールバックの概要は完全な文である必要はありません。
content/en-us/tutorials の.mdファイル内のチュートリアル
タスクベースのガイドと比較して、チュートリアルはより自己完結型であり、何もないところから何かを生み出すことができます。具体的なものを作成することに重点を置いているということは、通常、ガイドよりもはるかに規範的なものであることを意味します。多くの場合、チュートリアルでは同時に複数の機能や概念に触れ、ツールと戦略の関係を示します。
あなたの投稿がこれらのカテゴリに当てはまらない場合、または特に狭い主題をカバーしている場合は、ドキュメントに適さない可能性があります。 Roblox 開発者フォーラムに投稿することを検討してください。
プル リクエストをレビューしやすくするために、編集を 1 つのクラスまたは機能に限定するようにしてください。バグ修正や小規模な改善は、すぐに承認される可能性が高くなります。大規模なガイドでは、公開前に大幅なやり取りが必要になることがよくあります。
書式設定の問題を回避するには、Markdown を作成しながらプレビューできる github.dev などのテキスト エディターをお勧めします。散文の場合は、STYLE.md のガイドラインに従うようにしてください。コードサンプルについては、Lua スタイルガイドを使用してください。
mainブランチで表示される内容に従って完全にフォーマットされたページを表示するには、 content/以降の URL 全体を置き換えます。ベース名indexを持つファイルは、その名前を削除する必要があります。たとえば、「https://github.com/Roblox/creator-docs/blob/main/content/en-us/avatar/index.md」のページは「https://create.roblox.com」でレンダリングされます。 /docs/en-us/avatar」。
散文の場合、このプロジェクトはクリエイティブ コモンズ表示 4.0 国際パブリック ライセンスを使用します。ライセンスの全文については、「ライセンス」を参照してください。
コード サンプルは、MIT ライセンスに基づいて入手できます。ライセンスの全文については、「ライセンスコード」を参照してください。
オープンで歓迎的、多様性があり、包括的で健全なコミュニティを維持するために、このプロジェクトは貢献者規約の修正版を施行します。詳細については、CODE_OF_CONDUCT.mdを参照してください。
