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

Setting up a Development environment using yarn and npm #1

Merged
merged 1 commit into from
Oct 9, 2023

Conversation

navdeepgill14
Copy link
Owner

Setting up a Development Environment using yarn and npm

Summary:

This pull request adds detailed instructions for setting up a development environment using yarn and npm in the CONTRIBUTING.md file. It provides an alternative method for contributors who prefer these tools over mamba. The instructions are meant to improve the onboarding experience for new contributors and ensure that the development environment is consistent and well-documented.

Changes Made:

  • Added a new subsection titled "Alternative : Using yarn or npm over mamba " to the CONTRIBUTING.md file.
  • Included step-by-step instructions for installing Node.js dependencies, setting up a Python virtual environment, installing Python dependencies, building the Jupyter Notebook, enabling the server extension, and starting the Jupyter Notebook.

Resolves Issue:

Closes jupyter#7029

Motivation:

Some contributors may prefer using yarn or npm for their development workflow, and this addition aims to accommodate their preferences. By providing clear and detailed instructions, we can make it easier for a broader range of developers to contribute to the project.

Checklist:

  • I have tested the instructions and confirmed that they work as expected.
  • The documentation is well-formatted and easy to follow.
  • I have followed the project's style and formatting guidelines.
  • I have updated the CONTRIBUTING.md file to include this new section.

Additional Context:

Thank you for considering this pull request. I look forward to your feedback and the opportunity to improve the contributor experience.

Added the steps to use while setting up an environment using "yarn" and "npm" depending on user preference.
@navdeepgill14 navdeepgill14 changed the title Added "yarn" and "npm" steps in CONTRIBUTING.md Setting up a Development environment using yarn and npm Oct 9, 2023
@navdeepgill14 navdeepgill14 merged commit c2e33f6 into main Oct 9, 2023
@navdeepgill14 navdeepgill14 deleted the navdeepgill14-patch-1 branch October 9, 2023 23:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add guidelines for setting up development environment using yarn and npm in CONTRIBUTING.md
1 participant