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

Ouverte Adaptée aux débutants
  • Quelque chose ne va pas ?
#269 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
82/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
javascript, node.js
Domaine
documentation, testing

Piste de recherche

Lisez les sections indiquées dans CONTRIBUTING.md, .github/PULL_REQUEST_TEMPLATE.md et site/checks.mjs, puis comparez le workflow de publication avec le job CI sous Node 22. Mettez à jour les consignes destinées aux contributeurs et les messages V6 pour qu’ils correspondent au comportement du validateur et du workflow. Exécutez npm test ; le travail est terminé lorsque les trois éléments de la liste de contrôle sont corrigés et que les tests réussissent.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Langage dominant
JavaScript
Étoiles
58
Forks
15
Merge moyen
1 j 15 h
PR mergées (30 j)
12

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de TMHSDigital/Free-Game-Dev-Assets

Toutes les issues de TMHSDigital/Free-Game-Dev-Assets

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.