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

オープン 初心者向け
  • 何か問題がありますか？
#45 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
1/5
見積もり時間
1〜3時間
初心者へのやさしさ
82/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
javascript
領域
documentation

調査の方向性

docs/ROADMAP.mdから始め、記載されている各主張を、index.html内で参照されている行および既存のJestスイートと照合して確認してください。機能のセットアップ手順についてはdocs/ARCHITECTURE.mdを読み、issueで提案されている編集内容を使ってロードマップの各セクションを修正し、既存のテストカバレッジを正確に記述してください。npm testとnpm run lintを実行してください。受け入れ基準にある4つの不整合をすべて修正したら完了です。

索引モデルが issue の本文から書いたものです。

説明

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

主要言語
JavaScript
スター
4
フォーク
2
30日以内にマージされた PR はありません

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

TMHSDigital/Static_Chess のほかの issue

TMHSDigital/Static_Chess の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。