README "no config" claim conflicts with the registry.json step
還沒有人認領這個 Issue。
評估
- 難度
- 2/5
- 預估耗時
- 1-3 小時
- 新手友好度
- 78/100
- Issue 類型
- 文件
- 描述清晰度
- 描述清楚
- 活躍度
- 活躍
- 技術堆疊
- typescript, vite
研究方向
閱讀 README.md 中的 make-your-own-game 部分，接著檢查 scripts/new-game.mjs:35-46 和 vite.config.ts:26,65。執行 npm install，然後執行 npm run dev 檢視流程；使用 npm run typecheck 和 npm run build 檢查變更。當 README 的措辭、產生器的輸出和 Phaser 大小註解一致（包括 registry 和選用縮圖的說明）時，即表示完成。
由索引模型根據 Issue 內容生成。
描述
Summary
Small inaccuracies in the "make your own game" docs and one stale comment.
Where
README.md:177,README.md:209,README.md:219-233scripts/new-game.mjs:35-42,scripts/new-game.mjs:45-46vite.config.ts:26,vite.config.ts:65
Details
- The README says "No config to edit" and "no config files", but step 2 is editing
games/registry.json. Reword to "no build config to edit". - The scaffolder writes placeholder description and a
newtag that show on the live hub if left alone, and its console output does not mention the registry or the optionalthumbnailfield. Add a "Next:" line. -
vite.config.ts:26says Phaser is about 1.2 MB minified; line 65 says about 1.5 MB. The built chunk is 1.48 MB.
Acceptance criteria
- README, scaffolder output and comments agree
Getting started
- Relevant files:
README.md,scripts/new-game.mjs,vite.config.ts - Run locally:
npm install, thennpm run dev - Checks:
npm run typecheckandnpm run build(there is no test suite yet) - Related docs:
README.md
Filed by repo-audit/full-audit at b001f5d. Severity: low. Effort: S. audit-key: documentation|README.md|make-your-own-game
- 主要語言
- TypeScript
- 星號
- 3
- 分支
- 3
- PR 合併指標
- 30 天內沒有已合併 PR
環境準備
這個專案沒有提供開發容器、Dockerfile 或貢獻指南，環境需要你自己搭建：先看它的 README，通用步驟見我們的新手貢獻指南。
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
TMHSDigital/GH-Arcade 的其他 Issue
-
enhancement good first issue severity: low
難度 2/5 1-3 小時 新手友好度 82/100
TMHSDigital/GH-Arcade#50 ·
-
enhancement good first issue severity: medium
難度 2/5 1-3 小時 新手友好度 86/100
TMHSDigital/GH-Arcade#47 ·
-
documentation good first issue severity: low
難度 2/5 1-3 小時 新手友好度 78/100
TMHSDigital/GH-Arcade#34 ·
-
dependencies good first issue severity: low
難度 2/5 1-3 小時 新手友好度 85/100
TMHSDigital/GH-Arcade#27 ·
-
dependencies good first issue severity: low
難度 2/5 1-3 小時 新手友好度 82/100
TMHSDigital/GH-Arcade#23 ·
查看 TMHSDigital/GH-Arcade 的全部 Issue
相似的 Issue
-
automated-triage type/bug type/ci
難度 2/5 1-3 小時 新手友好度 78/100
維護者通常 1 天內回覆
-
📦 expo-router Android contributor: external needs review sdk-58 severity: medium
難度 2/5 1-3 小時 新手友好度 78/100
維護者通常 1 天內回覆
-
documentation good first issue
難度 2/5 1-3 小時 新手友好度 84/100
asasemahmed/openboard#68 ·
維護者通常 1 天內回覆
-
bug good first issue
難度 2/5 1-3 小時 新手友好度 72/100
-
Document PowerShell shell semantics and read-only Bash deduplication in Built-in Tools reference未關閉documentation
難度 2/5 1-3 小時 新手友好度 78/100