Docs say Undo reopens a timed-out game; ROADMAP line count is stale

オープン 初心者向け
#155 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

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

評価

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

調査の方向性

README.md、CHANGELOG.md、docs/ARCHITECTURE.md、docs/ROADMAP.mdに記載された箇所を読み、js/game.jsで引用されている取り消し動作と比較してください。時間制ゲームの表現を更新し、game.jsの古い行数を削除してください。書式を確認するために npm run format を実行してください。

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

説明

documentation good first issue severity: low

Summary

Two small inaccuracies remain in the docs. Everything else in README, ARCHITECTURE, RELEASE, CONTRIBUTING and releases/README was checked against the code and matches.

Checklist

  • Undo after a resignation, an agreed draw or a timeout. docs/ARCHITECTURE.md:305 lists "a loss on time" among the endings endGameWithoutMove() handles, and :308 says "Undo reopens a game ended this way". README.md:185 and CHANGELOG.md:22 say the same about resignations and agreed draws, with no exception. In the code, undoLastMove() starts with if (clock) return; (js/game.js:708), and the button is disabled with canUndo: !clock && ... (js/game.js:1380). A loss on time always has a clock, so it can never be reopened, and neither can a resignation in a timed game. ARCHITECTURE.md:241 ("Undo is off in a timed game") already contradicts line 308.
    • Fix: ARCHITECTURE.md:308: "...except in a timed game, where Undo is off, so a loss on time is final". Add "(not in a timed game)" at README.md:185 and CHANGELOG.md:22.
  • game.js size. docs/ROADMAP.md:103 says game.js has "about 1,550 lines". It has 1,656. Drop the number so it does not go stale again.

Getting started

  • Relevant files: README.md, CHANGELOG.md, docs/ARCHITECTURE.md, docs/ROADMAP.md
  • Check formatting with npm run format

Filed by repo-audit/full-audit at 73cd279. Severity: low. Effort: S. audit-key: documentation|docs/ARCHITECTURE.md|endGameWithoutMove

主要言語
JavaScript
スター
4
フォーク
2
平均マージ
6時間 13分
マージ済み PR(30日)
4

環境構築

はじめの一歩

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

TMHSDigital/Static_Chess のほかの issue

TMHSDigital/Static_Chess の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

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

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