README screenshots and two How to Play lines describe the old interface

未關閉 適合新手
#79 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

評估

難度
2/5
預估耗時
1-3 小時
新手友好度
72/100
Issue 類型
文件
描述清晰度
描述清楚
活躍度
活躍
技術堆疊
css, html, javascript

研究方向

從 README.md 第 121-125、161 和 169 行開始,並對照正在執行的遊戲以及 index.html:30-51(其中包含被吃棋子的進度條)核實這些說法。升變選擇器在同一檔案第 72 行有所描述。完成的標準是:assets/screenshots/ 中的兩張截圖都顯示目前的版面且說明文字已更新,第 161 和 169 行與實際行為一致,並且 npm run format 通過。

由索引模型根據 Issue 內容生成。

描述

documentation good first issue severity: low

Summary

The README's two screenshots and two "How to Play" lines describe the game as it was before the recent features and layout changes, so the README no longer matches the live site.

Where

  • README.md:121-125 (screenshots and caption)
  • README.md:161 (promotion)
  • README.md:169 (captured pieces)
  • assets/screenshots/ui-with-settings.png, assets/screenshots/ui-without-settings.png

Details

  • Screenshots. Both images were last changed on 2025-11-02. Since then index.html and the stylesheets have had 22 commits, including the Hint, Offer draw and Resign buttons, the clock, the captured-piece bars beside the board, the Load PGN and Copy FEN buttons and the folded "Settings" section (see CHANGELOG.md, Unreleased). The caption "without settings panel (left) and with settings panel (right)" refers to a layout that no longer exists.
  • Line 161 says "A pawn that reaches the last rank becomes a queen". The game shows a chooser for queen, rook, bishop or knight, as line 72 of the same file says.
  • Line 169 says the captured pieces "are shown under the Move History". They are now in a bar for each player beside the board (index.html:30-51).

Impact

Visitors deciding whether to try the game see an interface it no longer has, and two instructions that are wrong.

Suggested fix

  • Retake both screenshots from the live site, for example one of a game in progress and one with "Settings" open, and update the caption.
  • Line 161: "A pawn that reaches the last rank is promoted; choose a queen, rook, bishop or knight".
  • Line 169: say the captured pieces and the material lead are shown in each player's bar beside the board.

Acceptance criteria

  • Both screenshots show the current layout
  • Lines 161 and 169 match the game's behaviour

Related: #48

Getting started

  • Relevant files: README.md, assets/screenshots/
  • How to run tests: npm run format (Prettier checks Markdown)

Filed by repo-audit/pages-audit at 0144de7. Severity: low. Effort: S. audit-key: documentation|README.md|screenshots

主要語言
JavaScript
星號
4
分支
2
平均合併
4 小時 8 分鐘
30 天內合併 PR
1

環境準備

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

TMHSDigital/Static_Chess 的其他 Issue

查看 TMHSDigital/Static_Chess 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。