Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

docs: README says Node 22 is required, but .nvmrc pins v24 and preinstall enforces it

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

@ishan-one8 ya está trabajando en esto.

Desde el 3/10/2026.

  • #1378 de @ishan-one8 — abierto

Evaluación

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

Línea de trabajo

Comienza con README.md y luego compara sus prerrequisitos con .nvmrc y scripts/node-check.js para documentar la versión de Node impuesta y el comportamiento de preinstall. Revisa las instrucciones de pruebas de los paquetes, incluido el comando de packages/layout_editor node --test src/lib/*.test.js y el requisito de ejecutar las pruebas del paquete desde dentro del paquete. La tarea estará terminada cuando los colaboradores puedan instalar la versión correcta de Node y encontrar los comandos de prueba relevantes sin tener que leer archivos package.json.

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

Descripción

Problem

README.md tells new contributors to install Node 22:

  • Node.js: Version 22 (LTS) is required.

But .nvmrc pins v24.0.0, and scripts/node-check.js runs on preinstall and enforces the .nvmrc major:

const expectedVersion = fs.readFileSync(nvmrcPath).toString().trim();
const expectedMajor = semver.major(expectedVersion);

if (!semver.satisfies(process.version, `^${expectedMajor}`)) {
  console.error(`Error: Required Node.js major version is ${expectedMajor}, but found ${process.version}. ...`);
  process.exit(1);
}

So anyone who follows the README, installs Node 22 and runs yarn is rejected at preinstall before a single dependency is fetched. The README is the first thing a new contributor reads, and following it exactly is what breaks their setup.

The surrounding instructions have the same gap — they say:

nvm install <version>
nvm use <version>

Replace <version> with the required Node.js version

while never saying that nvm install / nvm use with no argument read .nvmrc on their own, which is the thing that cannot drift.

Also missing: how to run the tests

There is no CONTRIBUTING.md in this repo and the README never says how to run tests. Working out that packages/layout_editor runs node --test src/lib/*.test.js, and that a package's tests have to be run from inside that package (otherwise Babel resolves its root config from the wrong cwd and never finds packages/react/babel.config.js), is currently something each contributor rediscovers by reading package.json files.

Proposed change

  1. Rewrite the Prerequisites bullet so .nvmrc is named as the source of truth, show nvm install / nvm use with no argument, and mention that yarn verifies this on preinstall and what the failure looks like.
  2. Add a short Running the tests section covering which packages have tests and how to run them, including the run-from-inside-the-package detail.

This is the exact thing that cost me the most time getting started, so I'd like to write it. Happy to split it into two PRs if you'd prefer the version fix on its own.

Lenguaje dominante
JavaScript
Estrellas
168
Forks
382
Sin PR fusionados en 30 d

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

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 RocketChat/EmbeddedChat

Todos los issues de RocketChat/EmbeddedChat

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.