創建者文檔

Roblox 創作者文檔

此儲存庫包含 create.roblox.com/docs 上建立者文件的原始碼。

注意：目前，儲存庫包含指南、教學課程、教育內容和引擎 API 參考。程式碼範例即將推出。

如果您不熟悉 GitHub 貢獻流程，請參閱關於拉取請求和以下影片。

報告問題

如果您發現文件有問題且不想提交拉取請求，請透過在 Roblox 開發者論壇上報告告知我們。

貢獻指南

Roblox 創作者文件的任何補充都必須適應更大的整體。換句話說，即使是一篇全面、準確、寫得好的部落格文章或科技白皮書也可能在網站上沒有立足之地。

一般來說，我們尋找符合我們現有標準並適用於各種體驗和用例的內容。例如，我們更喜歡「建立使用者介面」之類的頁面，而不是「為賽車遊戲創建車速表」之類的頁面。考慮在 Roblox 開發者論壇上發布更專業的指南。

當您提交拉取請求以供審核時，您必須同意以下內容：

• 此貢獻全部或部分由我創建，我有權根據此存儲庫的開源許可證條款提交它。

• 我瞭解並同意，此貢獻及其記錄是公開的，無限期維護，並且可以根據此儲存庫的開源授權條款重新分發。

• 據我所知，所有提議的更改都是準確的。

小貢獻

對於僅涉及單一文件的簡單更改，請使用 GitHub 的基於 Web 的編輯器：

1. 在content/en-us/中找到該文件，然後按一下編輯此文件。

2. 按一下分叉此儲存庫。

3. 進行更改並點擊提交更改...。

4. 為您的變更提供描述性提交訊息，然後按一下「建議變更」 。

5. 確保基礎儲存庫是Roblox/creator-docs並且基礎分支是main 。確認您對變更感到滿意，然後按一下建立拉取請求。

6. 最後，填寫拉取請求描述中的詳細信息，然後按一下建立拉取請求。

更大的貢獻

對於涉及多個檔案的較大更改，我們推薦 github.dev，這是一個基於 Visual Studio Code 的功能更齊全的文字編輯器，可在瀏覽器中運行：

1. 分叉儲存庫。

2. 瀏覽您的 fork 時，按。開啟 github.dev 的金鑰。

3. 在原始碼管理選單中，按一下... >分支>建立分支...。

4. 為分支命名並點選Switch to Branch 。

5. 使用資源管理器選單在content/en-us中尋找要更新的文件，然後進行所需的變更。

6. 在「原始碼管理」功能表中，驗證您對所做的變更是否滿意。

7. 新增提交訊息並點擊Commit & Push 。

8. 在新的瀏覽器標籤中，導航至 github.com/Roblox/creator-docs。

9. 按一下「比較並拉取請求」 。

10. 驗證基礎儲存庫是Roblox/creator-docs且基礎分支是main 。頭存儲庫應該是您的分支和分支。

11. 最後，填寫拉取請求描述中的詳細信息，然後按一下建立拉取請求。

或者，您可以使用 github.dev 中的GitHub或GitHub Pull Request選單提交拉取請求。有關使用 github.dev 的文檔，請參閱 GitHub Codespaces。

離線工作流程

該存儲庫非常大，因此我們建議盡可能使用線上選項。但是，如果您已經熟悉一般 GitHub 工作流程並且想要使用離線文字編輯器，則以下是貢獻文件的基本步驟：

1. 設定 Git 和 Git LFS。或者，安裝 Git 用戶端，例如 GitHub Desktop。

2. 分叉這個儲存庫。

3. 克隆你的叉子。

4. 導航到儲存庫根目錄。

5. 建立一個新分支。

6. 進行您想要的更改。

7. 提交，推送到您的分支，然後針對此儲存庫的main分支提交拉取請求。

有關更詳細的步驟，請參閱 CONTRIBUTING.md。

文件類型

Roblox 文件有三種主要文件類型：

• content/en-us/ 中.md檔案中的概念和基於任務的指南

  指南會向您介紹某個功能或工作流程，但不會對最終結果做出太多規定。它們介紹了概念和功能，並涵蓋了您可以使用各種工具或其他方法完成的任務。

  指南從實際的、真實的用例、圖像、程式碼片段和圖表中受益匪淺。大多數基於任務的內容應包含編號清單。

• content/en-us/reference 中.yaml文件中的 API 參考文檔

  API 完全是參考內容，應使用功能描述，並在適當的情況下連結到指南。與其他內容類型相比，參考內容應該簡潔、直接；屬性、方法、事件和回呼的摘要不需要是完整的句子。

• content/en-us/tutorials 中的.md檔案中的教學

  與基於任務的指南相比，教程更加獨立，可以帶您從無到有。這種對創建特定內容的關注意味著它們通常比指南更具規範性。教程通常會同時涉及多個功能和概念，以展示工具和策略之間的連結。

如果您的貢獻不屬於這些類別或涵蓋特別狹窄的主題，則它可能不太適合文件。考慮將其發佈到 Roblox 開發者論壇。

貢獻基礎知識

嘗試將您的編輯限制為一個類別或功能，以便拉取請求更容易審查。錯誤修復和較小的改進更有可能獲得快速批准。大型指南在出版前通常需要進行大量的反覆討論。

為了避免格式問題，我們建議使用 github.dev 等文字編輯器，讓您在撰寫 Markdown 時預覽。對於散文，請嘗試遵循 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/頭像」。

許可證

• 對於散文，本計畫使用知識共享署名 4.0 國際公共授權。有關完整的許可證文本，請參閱許可證。

• 程式碼範例可根據 MIT 許可證取得。有關完整的許可證文本，請參閱許可證代碼。

行為守則

為了維持一個開放、熱情、多元化、包容和健康的社區，該計畫強制執行了貢獻者契約的改編版本。有關更多信息，請參閱 CODE_OF_CONDUCT.md。