CONTRIBUTING and the PR template miss two validator rules and overstate release testing

Offen Anfängerfreundlich
  • Stimmt etwas nicht?
#269 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
82/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
javascript, node.js
Bereich
documentation, testing

Rechercherichtung

Lies die benannten Abschnitte in CONTRIBUTING.md, .github/PULL_REQUEST_TEMPLATE.md und site/checks.mjs und vergleiche dann den Release-Workflow mit dem Node-22-CI-Job. Aktualisiere die Hinweise für Mitwirkende und die V6-Meldungen, damit sie dem Verhalten des Validators und des Workflows entsprechen. Führe npm test aus; fertig ist die Aufgabe, wenn alle drei Checklistenpunkte korrigiert sind und die Tests bestehen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

documentation priority: medium

Summary

Contributors who deprecate an entry or add a new licence hit validator failures the docs do not predict, and CONTRIBUTING says releases run on Node 22 when they do not.

Where

  • CONTRIBUTING.md:39, :48, :68, :73
  • .github/PULL_REQUEST_TEMPLATE.md:14
  • site/checks.mjs:115-118, :1018-1045
  • site/sync-counts.mjs:3-10
  • .github/workflows/release.yml:41-61

Details

  • Deprecating needs npm run counts. README counts include listed entries only, so status: deprecated makes V6 fail. CONTRIBUTING step 5 and the PR template say "adding or removing"; the V6 errors (checks.mjs:1020, :1031, :1037, :1044) never mention npm run counts.
  • New licences also need site/spdx-allowed.json. CONTRIBUTING:48 mentions only site/license-vocabulary.json, but checks.mjs:115-118 rejects any license_spdx missing from spdx-allowed.json.
  • Releases run on Node 24 only. CONTRIBUTING:73 says every release runs on 24 and 22; only ci.yml has the Node 22 job.

Impact

Avoidable validator failures for contributors and an overstated testing claim.

Steps to reproduce

  1. Set status: deprecated on any active entry and add the - Deprecated: line.
  2. npm run validate reports V6 count errors with no hint of the fix.

Suggested fix

Say "adding, removing or deprecating" in CONTRIBUTING step 5, the status bullet and the PR template; append "(run npm run counts)" to the V6 messages; add "and its SPDX id to site/spdx-allowed.json" at :48; say PRs and pushes run on 24 and 22 and releases on 24.

Acceptance criteria

  • Every checklist item fixed

Getting started

  • Relevant files: CONTRIBUTING.md, .github/PULL_REQUEST_TEMPLATE.md, site/checks.mjs
  • 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: medium. Effort: S. audit-key: documentation|CONTRIBUTING.md|counts-spdx-release

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.