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

Aperta Adatta ai principianti
#155 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
1-3 ore
Idoneità per principianti
90/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
javascript
Ambito
documentation

Direzione di ricerca

Leggi i passaggi indicati in README.md, CHANGELOG.md, docs/ARCHITECTURE.md e docs/ROADMAP.md, quindi confrontali con il comportamento di annullamento citato in js/game.js. Aggiorna la formulazione relativa al gioco a tempo e rimuovi il conteggio obsoleto delle righe di game.js; esegui npm run format per controllare la formattazione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
JavaScript
Stelle
4
Fork
2
Merge medio
6h 13m
PR unite (30g)
4

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di TMHSDigital/Static_Chess

Tutte le issue di TMHSDigital/Static_Chess

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.