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