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

Aperta Adatta ai principianti
  • Qualcosa non va?
#33 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
78/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
typescript, vite
Ambito
developer-experience, documentation

Direzione di ricerca

Leggi la sezione make-your-own-game in README.md, poi esamina scripts/new-game.mjs:35-46 e vite.config.ts:26,65. Esegui npm install, poi npm run dev per verificare il flusso; usa npm run typecheck e npm run build per controllare le modifiche. Il lavoro è completo quando il testo di README, l’output del generatore e i commenti sulle dimensioni di Phaser concordano, comprese le indicazioni sul registry e sulla miniatura facoltativa.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
TypeScript
Stelle
3
Fork
3
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di TMHSDigital/GH-Arcade

Tutte le issue di TMHSDigital/GH-Arcade

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.