Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#1,377 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

@ishan-one8 đang làm issue này rồi.

Từ ngày 3/10/2026.

  • #1378 của @ishan-one8 — đang mở

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
88/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
javascript, node.js
Lĩnh vực
developer-experience, documentation, testing

Hướng nghiên cứu

Bắt đầu với README.md, sau đó đối chiếu các điều kiện tiên quyết trong đó với .nvmrc và scripts/node-check.js để ghi lại phiên bản Node bắt buộc và hành vi preinstall. Xem lại hướng dẫn kiểm thử package, bao gồm lệnh của packages/layout_editor node --test src/lib/*.test.js và yêu cầu chạy các bài kiểm thử của package từ bên trong package. Công việc được coi là hoàn tất khi các contributor có thể cài đặt đúng phiên bản Node và tìm thấy các lệnh kiểm thử liên quan mà không cần đọc các tệp package.json.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
JavaScript
Star
168
Fork
382
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của RocketChat/EmbeddedChat

Tất cả issue của RocketChat/EmbeddedChat

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.