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

Ouverte Adaptée aux débutants
  • Quelque chose ne va pas ?
#45 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
1/5
Temps estimé
1-3 heures
Accessibilité débutants
82/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
javascript
Domaine
documentation

Piste de recherche

Commencez par docs/ROADMAP.md et vérifiez chaque affirmation répertoriée à l’aide des lignes référencées dans index.html et des suites Jest existantes. Lisez docs/ARCHITECTURE.md pour consulter les instructions de configuration de la fonctionnalité ; utilisez les modifications suggérées dans l’issue pour corriger les sections de la feuille de route et décrire fidèlement la couverture des tests existante. Exécutez npm test et npm run lint ; le travail est terminé lorsque les quatre incohérences des critères d’acceptation sont corrigées.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Langage dominant
JavaScript
Étoiles
4
Forks
2
Aucune PR mergée en 30 j

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de TMHSDigital/Static_Chess

Toutes les issues de TMHSDigital/Static_Chess

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.