README and catalog/README give incomplete filter and guide lists

Offen Anfängerfreundlich
  • Stimmt etwas nicht?
#270 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
78/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
javascript
Bereich
documentation

Rechercherichtung

Lies die aufgeführten Abschnitte in README.md und catalog/README.md und prüfe dann in CONTRIBUTING.md den Ablauf für npm run new-entry sowie die README-Guide-Tabelle. Aktualisiere die Pfade im internen Site-Refresh-Plan unter docs/internal/superpowers/plans/, sodass sie auf docs/internal/superpowers/specs/ verweisen. Erledigt, wenn alle vier Checklistenpunkte korrigiert sind; im Issue werden npm test und npm run check als Verifizierungsbefehle genannt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

documentation good first issue priority: low

Summary

The README's description of site filters leaves out several that exist, and the catalog index still steers contributors to copy TEMPLATE.md instead of using the scaffold.

Where

  • README.md:153-155
  • catalog/README.md:3, :18
  • docs/internal/superpowers/plans/2026-10-23-site-refresh.md:11, :465

Details

  • README:153-155 lists category, commercial use, attribution, review status and 2D camera view; it omits the Licence, Format and Engine filters (license-family, format-group, engine in index.html), the sort control and the shortlist.
  • catalog/README.md:3 says "Copy TEMPLATE.md to add entries"; CONTRIBUTING uses npm run new-entry, which also fills the date and checks the id is unique.
  • catalog/README.md:18 omits docs/shipping.md, docs/data.md and docs/for-publishers.md (all listed in the README guide table).
  • The internal site-refresh plan cites docs/superpowers/specs/...; the file is now under docs/internal/superpowers/specs/.

Impact

Readers miss filters that exist; contributors skip the scaffold that prevents id collisions.

Suggested fix

Update each item in the checklist.

Acceptance criteria

  • Every checklist item fixed

Getting started

  • Relevant files: README.md, catalog/README.md
  • Run the tests: npm test; the full local gate is npm run check (Node 22+, no install step)
  • Related docs: CONTRIBUTING.md, site/README.md

Filed by repo-audit/full-audit at 4adb944. Severity: low. Effort: S. audit-key: documentation|README.md|filters-list

Vorherrschende Sprache
JavaScript
Sterne
58
Forks
15
Ø Merge
1 T. 15 Std.
Gemergte PRs (30 T.)
12

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus TMHSDigital/Free-Game-Dev-Assets

Alle Issues in TMHSDigital/Free-Game-Dev-Assets

Ähnliche Issues

Weitere Issues zu JavaScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.