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.

Sign up for GitHub

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

Jump to bottom

Add guidelines for setting up development environment using yarn and npm in CONTRIBUTING.md #7029

Open
riyanswat opened this issue Sep 3, 2023 · 2 comments · Fixed by navdeepgill14/notebook#1 · May be fixed by #7100
Open

Add guidelines for setting up development environment using yarn and npm in CONTRIBUTING.md #7029

riyanswat opened this issue Sep 3, 2023 · 2 comments · Fixed by navdeepgill14/notebook#1 · May be fixed by #7100
Labels
documentation enhancement

Comments

@riyanswat
Copy link

riyanswat commented Sep 3, 2023 •
edited

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.
@riyanswat riyanswat added enhancement status:Needs Triage Applied to issues that need triage labels Sep 3, 2023
@riyanswat riyanswat changed the title 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 Sep 3, 2023
@jtpio
Copy link
Member

jtpio commented 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 the venv module for creating the virtual environment if you think that would be useful?

@RRosio RRosio added documentation and removed status:Needs Triage Applied to issues that need triage labels Sep 5, 2023
@JasonWeill JasonWeill mentioned this issue Sep 5, 2023
Closed
This was referenced Oct 9, 2023
Merged
Open
@navdeepgill14
Copy link

Hi everyone,

I've addressed this issue by adding instructions for setting up a development environment using yarn and npm in the CONTRIBUTING.md file. This should provide a more inclusive approach for contributors who prefer these tools over mamba.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation enhancement
Projects
None yet
Milestone
No milestone
4 participants
@jtpio @riyanswat @RRosio @navdeepgill14