README "no config" claim conflicts with the registry.json step

オープン 初心者向け
  • 何か問題がありますか？
#33 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
78/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
typescript, vite
領域
developer-experience, documentation

調査の方向性

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 の本文から書いたものです。

説明

documentation good first issue severity: low

Summary

Small inaccuracies in the "make your own game" docs and one stale comment.

Where

  • README.md:177, README.md:209, README.md:219-233
  • scripts/new-game.mjs:35-42, scripts/new-game.mjs:45-46
  • vite.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 new tag that show on the live hub if left alone, and its console output does not mention the registry or the optional thumbnail field. Add a "Next:" line.
  • vite.config.ts:26 says 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, then npm run dev
  • Checks: npm run typecheck and npm 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
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

TMHSDigital/GH-Arcade のほかの issue

TMHSDigital/GH-Arcade の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。