Skip to content

docs: align node/npm versions in development guide#1901

Merged
asyncapi-bot merged 2 commits intoasyncapi:masterfrom
Satya900:doc_fix_node
Feb 4, 2026
Merged

docs: align node/npm versions in development guide#1901
asyncapi-bot merged 2 commits intoasyncapi:masterfrom
Satya900:doc_fix_node

Conversation

@Satya900
Copy link
Contributor

@Satya900 Satya900 commented Feb 1, 2026

Description

Updated the Troubleshooting section in Development.md to match the node and npm versions specified in the engines field of package.json.

Changes

The previous values (Node 18.20.8 / npm 10.8.2) conflicted with the actual requirement (node >= 24.11, npm >= 11.5.1), which can confuse new contributors and cause EBADENGINE errors.
FILE CHANGED -> Development.md

Related Issue

Resolves issue #1878

Summary by CodeRabbit

  • Documentation
    • Updated minimum environment version requirements: Node.js 24.11+ and npm 11.5.1+ (previously Node.js 18.20.8+ and npm 10.8.2+).

✏️ Tip: You can customize this high-level summary in your review settings.

@changeset-bot
Copy link

changeset-bot bot commented Feb 1, 2026

⚠️ No Changeset found

Latest commit: 754a417

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@asyncapi-bot
Copy link
Contributor

What reviewer looks at during PR review

The following are ideal points maintainers look for during review. Reviewing these points yourself beforehand can help streamline the review process and reduce time to merge.

  1. PR Title: Use a concise title that follows our Conventional Commits guidelines and clearly summarizes the change using imperative mood (it means spoken or written as if giving a command or instruction, like "add new helper for listing operations")

    Note - In Generator, prepend feat: or fix: in PR title only when PATCH/MINOR release must be triggered.

  2. PR Description: Clearly explain the issue being solved, summarize the changes made, and mention the related issue.

    Note - In Generator, we use Maintainers Work board to track progress. Ensure the PR Description includes Resolves #<issue-number> or Fixes #<issue-number> this will automatically close the linked issue when the PR is merged and helps automate the maintainers workflow.

  3. Documentation: Update the relevant Generator documentation to accurately reflect the changes introduced in the PR, ensuring users and contributors have up-to-date guidance.

  4. Comments and JSDoc: Write clear and consistent JSDoc comments for functions, including parameter types, return values, and error conditions, so others can easily understand and use the code.

  5. DRY Code: Ensure the code follows the Don't Repeat Yourself principle. Look out for duplicate logic that can be reused.

  6. Test Coverage: Ensure the new code is well-tested with meaningful test cases that pass consistently and cover all relevant edge cases.

  7. Commit History: Contributors should avoid force-pushing as much as possible. It makes it harder to track incremental changes and review the latest updates.

  8. Template Design Principles Alignment: While reviewing template-related changes in the packages/ directory, ensure they align with the Assumptions and Principles. If any principle feels outdated or no longer applicable, start a discussion these principles are meant to evolve with the project.

  9. Reduce Scope When Needed: If an issue or PR feels too large or complex, consider splitting it and creating follow-up issues. Smaller, focused PRs are easier to review and merge.

  10. Bot Comments: As reviewers, check that contributors have appropriately addressed comments or suggestions made by automated bots. If there are bot comments the reviewer disagrees with, react to them or mark them as resolved, so the review history remains clear and accurate.

@dosubot
Copy link

dosubot bot commented Feb 1, 2026

Related Documentation

No published documentation to review for changes on this repository.

Write your first living document

How did I do? Any feedback?  Join Discord

@coderabbitai
Copy link

coderabbitai bot commented Feb 1, 2026

📝 Walkthrough

Walkthrough

Development.md was updated to reflect new minimum environment version requirements: Node.js upgraded from 18.20.8+ to 24.11+ and npm upgraded from 10.8.2+ to 11.5.1+ across multiple documentation sections.

Changes

Cohort / File(s) Summary
Documentation Version Updates
Development.md
Updated minimum Node.js version requirement from 18.20.8+ to 24.11+ and npm version requirement from 10.8.2+ to 11.5.1+ in the development issues checklist and troubleshooting sections.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'docs: align node/npm versions in development guide' uses the 'docs:' prefix per Conventional Commits, employs imperative mood ('align'), and clearly summarizes the main change—updating Node.js and npm version documentation in the development guide.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@Satya900
Copy link
Contributor Author

Satya900 commented Feb 2, 2026

i would request maintainers to check the issue #1878 . it has been closed by me by mistake. please open that and check the code changes and give your feedback so that i can proceed forward....

@Adi-204 Adi-204 self-assigned this Feb 2, 2026
@Adi-204 Adi-204 moved this to In Progress in Maintainers work Feb 2, 2026
@sonarqubecloud
Copy link

sonarqubecloud bot commented Feb 4, 2026

@derberg
Copy link
Member

derberg commented Feb 4, 2026

/rtm

@asyncapi-bot asyncapi-bot merged commit 185c1e8 into asyncapi:master Feb 4, 2026
14 of 15 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in Maintainers work Feb 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants