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

Abierto Apto para principiantes
  • ¿Algo no está bien?
#45 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
82/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
javascript
Área
documentation

Línea de trabajo

Empieza por docs/ROADMAP.md y verifica cada afirmación enumerada con las líneas referenciadas en index.html y las suites Jest existentes. Lee docs/ARCHITECTURE.md para obtener las indicaciones de configuración de la funcionalidad; usa las modificaciones sugeridas en el issue para corregir las secciones de la hoja de ruta y describir con precisión la cobertura de pruebas existente. Ejecuta npm test y npm run lint; el trabajo estará terminado cuando se corrijan las cuatro incoherencias de los criterios de aceptación.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
JavaScript
Estrellas
4
Forks
2
Sin PR fusionados en 30 d

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de TMHSDigital/Static_Chess

Todos los issues de TMHSDigital/Static_Chess

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.