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

Abierto Apto para principiantes
  • ¿Algo no está bien?
#269 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
82/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
javascript, node.js
Área
documentation, testing

Línea de trabajo

Lee las secciones indicadas en CONTRIBUTING.md, .github/PULL_REQUEST_TEMPLATE.md y site/checks.mjs; después, compara el flujo de publicación con el trabajo de CI de Node 22. Actualiza las indicaciones para colaboradores y los mensajes de V6 para que coincidan con el comportamiento del validador y del flujo de trabajo. Ejecuta npm test; la tarea estará terminada cuando se hayan corregido los tres elementos de la lista y las pruebas pasen.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
JavaScript
Estrellas
58
Forks
15
Merge medio
1 d 15 h
PR fusionados (30 d)
12

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de TMHSDigital/Free-Game-Dev-Assets

Todos los issues de TMHSDigital/Free-Game-Dev-Assets

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.