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

未关闭 适合新手
#155 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
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 分钟
30 天内合并 PR
4

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

TMHSDigital/Static_Chess 的其他 Issue

查看 TMHSDigital/Static_Chess 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。