Description
Problem
There are no instructions in the CONTRIBUTING.md for setting up development environment using yarn
or npm
. It does mention them but goes on to give instructions about mamba
only. I came here many times but the only thing that's kind of annoying is mamba... I don't like mamba and have yarn and npm set up on my machine.
Proposed Solution
Please add instructions for yarn
and npm
as some users prefer those tools to mamba
.
Activity
[-]Add guidelines for setting up development environment using yarn and npm[/-][+]Add guidelines for setting up development environment using yarn and npm in CONTRIBUTING.md[/+]jtpio commentedon Sep 4, 2023
This repository includes a Jupyter Server extension which is written in Python. And when working on a Python project it is highly recommended to create a new virtual environment to better isolate changes and packages.
The docs mention
mamba
as one way to create such environment. But we could also mention using thevenv
module for creating the virtual environment if you think that would be useful?navdeepgill14 commentedon Oct 10, 2023
Hi everyone,
I've addressed this issue by adding instructions for setting up a development environment using
yarn
andnpm
in the CONTRIBUTING.md file. This should provide a more inclusive approach for contributors who prefer these tools overmamba
.I understand the importance of creating a Python virtual environment, especially since this repository includes a Jupyter Server extension. To accommodate different preferences, I've included instructions for creating a virtual environment using the
venv
module as well.You can find the details in my pull request: Updated CONTRIBUTING.md with settings for yarn and npm
I hope this helps make the onboarding experience smoother for a wider range of contributors. Please feel free to review the pull request, and your feedback is greatly appreciated.
Thank you,
Navdeep