ROADMAP.md contradicts itself and its "enable the flag" recipe does not work

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

Ninguém assumiu esta issue ainda.

Avaliação

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

Direção de pesquisa

Comece por docs/ROADMAP.md e verifique cada afirmação listada com base nas linhas referenciadas em index.html e nas suítes Jest existentes. Leia docs/ARCHITECTURE.md para obter orientações sobre a configuração do recurso; use as edições sugeridas na issue para corrigir as seções do roadmap e descrever com precisão a cobertura de testes existente. Execute npm test e npm run lint; o trabalho estará concluído quando as quatro inconsistências nos critérios de aceitação forem corrigidas.

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

Descrição

documentation good first issue severity: low

Summary

The roadmap gives a wrong picture of what is done and a first step that has no effect.

Where

  • docs/ROADMAP.md:35-38, :95, :105, :109

Details

  • :105 calls js/drag.js a "Skeleton implementation", while :35 and :65 mark drag and drop as completed and the file is loaded and live (index.html:69).
  • :109 says "To implement a feature, enable its flag in config.js". For AI_OPPONENT and PROMOTION_UI this does nothing: index.html loads neither ai.js nor promotion.js.
  • :95 lists "Add automated tests for core functionality" as debt without acknowledging the Jest suites that exist.
  • :35-38 keeps finished items (Drag and Drop, Undo Move) under "Planned Features".

Suggested fix

Update :105; replace :109 with "load the script in index.html, enable the flag, then follow ARCHITECTURE"; move completed rows to "Current Status"; reword the test-coverage item.

Acceptance criteria

  • Each item above is corrected

Getting started

  • Relevant files: docs/ROADMAP.md
  • How to run tests: npm install, then npm test and npm run lint
  • Related docs: docs/ARCHITECTURE.md, .github/CONTRIBUTING.md

Filed by repo-audit/full-audit at 8a2c86c. Severity: low. Effort: S. audit-key: documentation|docs/ROADMAP.md|implementation-progress

Linguagem predominante
JavaScript
Estrelas
4
Forks
2
Nenhum PR com merge em 30d

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.