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

Aberta Para iniciantes
  • Algo errado?
#33 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
78/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
typescript, vite
Domínio
developer-experience, documentation

Direção de pesquisa

Leia a seção make-your-own-game em README.md e depois examine scripts/new-game.mjs:35-46 e vite.config.ts:26,65. Execute npm install e, em seguida, npm run dev para revisar o fluxo; use npm run typecheck e npm run build para verificar as alterações. O trabalho estará concluído quando o texto do README, a saída do gerador e os comentários sobre o tamanho do Phaser estiverem de acordo, incluindo as orientações sobre o registry e a miniatura opcional.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

Linguagem predominante
TypeScript
Estrelas
3
Forks
3
Nenhum PR com merge em 30d

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de TMHSDigital/GH-Arcade

Todas as issues de TMHSDigital/GH-Arcade

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.