Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

docs: ROADMAP.md contradicts the stacks, the feeds and a closed issue, and one sentence is broken

Chiusa
  • Qualcosa non va?
#145 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à
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
56/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
github, javascript
Ambito
devtools, documentation

Direzione di ricerca

Read ROADMAP.md, compare its claims with stacks/, site/README.md, site/lib/exports.mjs, and the referenced issues. Rewrite the three sections with current facts, move older Done items to docs/review-ledger.md, and add a check in the monthly re-verify workflow that ROADMAP issue references remain open. Done when ROADMAP has no contradictions and its broken sentence is whole.

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

Descrizione

documentation priority: medium

Why it matters

ROADMAP is where CONTRIBUTING and the README send new contributors to find work. #69 fixed an earlier round of the same drift, so a guard is worth adding this time.

Evidence (at 69387df)

  • ROADMAP.md:14: "Starter stacks: audio, a game-jam kit, Unity, Unreal and VR are not covered yet." stacks/3d-third-person-unreal.md exists and is linked from README.md:147 and the homepage.
  • ROADMAP.md:11-13 offers #41 (camera_perspective / grid_dimensions) as "a good first PR"; #41 is closed and camera_perspective is set on 50 entries. The remaining gap is open #98.
  • ROADMAP.md:21-22: the inserted sentence about reverify.yml splits the original one, leaving the fragment "together in mid-2027." dangling on line 22.
  • ROADMAP.md:33-34 says feed.xml is "of recently verified entries"; site/README.md:26-30 and site/lib/exports.mjs:103-109 say feed.xml is new sources by added and reverified.xml is the verified feed.
  • ROADMAP.md:8 names the thin categories as "video, animation and environment"; shaders-vfx (18) is now tied with animation (18), both below environment (20).

Suggested approach

Rewrite the three sections with today's facts; replace issue numbers with label links (good first issue, gap) so the file does not go stale when issues close; move "Done" items older than a quarter into docs/review-ledger.md. Add a small check (a gh call in the monthly re-verify workflow is enough) that every #N in ROADMAP is still open.

Done when

No sentence in ROADMAP contradicts stacks/, site/README.md or the issue tracker; the broken sentence is whole.

Lingua principale
JavaScript
Stelle
58
Fork
15
Merge medio
18h 42m
PR unite (30g)
11

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/Free-Game-Dev-Assets

Tutte le issue di TMHSDigital/Free-Game-Dev-Assets

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.