README demo GIF is 7.7 MB

Aberta Para iniciantes
#157 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
86/100
Tipo de issue
Refatoração
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
javascript
Domínio
performance

Direção de pesquisa

Comece pela referência à demonstração em README.md:131 e pelo arquivo de origem assets/screenshots/play-vs-computer.gif. Confira as dimensões da imagem e a taxa de quadros e, em seguida, compare as opções de compressão, confirmando que o clipe ainda mostra uma partida contra o computador. O trabalho estará concluído quando a demonstração do README tiver menos de aproximadamente 1,5 MB e continuar compreensível.

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

Descrição

good first issue performance severity: low

Summary

assets/screenshots/play-vs-computer.gif, added in the latest commit and embedded in the README, is 7.7 MB. That is about 80% of assets/.

Where

  • README.md:131
  • assets/screenshots/play-vs-computer.gif (7,870,061 bytes)

Impact

Every README view on GitHub downloads about 7.7 MB, which takes seconds on mobile. Every clone carries the file permanently in history, and the Pages deploy publishes it too. The app itself does not download it: the file is not in the service worker's file list.

Suggested fix

Reduce the frame rate, colours or dimensions to stay under about 1.5 MB, or use an MP4/WebM clip, which is usually about 10x smaller. GitHub READMEs can show a video uploaded as an asset. Replace the file soon, before more history accumulates.

Acceptance criteria

  • The README demo is under ~1.5 MB and still shows a game against the computer

Getting started

  • Relevant files: README.md, assets/screenshots/

Filed by repo-audit/full-audit at 73cd279. Severity: low. Effort: S. audit-key: performance|assets/screenshots/play-vs-computer.gif|readme-gif

Linguagem predominante
JavaScript
Estrelas
4
Forks
2
Merge médio
6h 13min
PRs com merge (30d)
4

Preparar o ambiente

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/Static_Chess

Todas as issues de TMHSDigital/Static_Chess

Issues semelhantes

Mais issues de JavaScript

Receba novas issues na sua caixa de entrada

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