Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): Add Node setup instructions for nvm to contributing guide #3611

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

RikhiSingh
Copy link

@RikhiSingh RikhiSingh commented Dec 7, 2024

fixes: #3612

Title

Add Node Setup Instructions to Contributing Guide

Description

This PR enhances the contributing guide by adding a detailed section on setting up Node.js using nvm (Node Version Manager). The new instructions ensure contributors can easily meet the project's Node.js version requirements.

Key changes include:

  • Steps to use nvm for selecting the correct Node.js version.
  • Instructions for installing nvm and required Node versions.
  • Links to the official nvm documentation for further guidance.
  • This addition reduces setup friction for new contributors and ensures consistent development environments across the team.

Contribution Checklist:

  • The pull request only addresses one issue or adds one feature.
  • The pull request does not introduce any breaking changes
  • I have added screenshots or gifs to help explain the change if applicable.
  • I have read the contribution guidelines.
  • Create an issue and link to the pull request.

Publishing to New Package Managers

Please see here for more information.

Screenshot

image

- Added a detailed section on using Node Version Manager (nvm) to the contributing guide.
- The new section explains how contributors can ensure their Node.js version meets the project's requirements using `nvm`.
- Included instructions for installing `nvm`, switching Node versions, and installing specific versions if necessary.

This change aims to help contributors quickly set up their environment and avoid potential compatibility issues.
@RikhiSingh
Copy link
Author

I personally had this issue, so writing this PR for others to have a frictionless local development setup!

@RikhiSingh RikhiSingh mentioned this pull request Dec 9, 2024
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Issue running nvm use command
1 participant