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

Updated CONTRIBUTING.md with settings for yarn and npm #7100

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

navdeepgill14
Copy link

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" and "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 #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.

navdeepgill14 and others added 3 commits October 10, 2023 10:34
Added the steps to use while setting up an environment using "yarn" and "npm" depending on user preference.
Added "yarn" and "npm" steps in CONTRIBUTING.md
@github-actions
Copy link
Contributor

Binder 👈 Launch a Binder on branch navdeepgill14/notebook/main

CONTRIBUTING.md Outdated
```bash
jupyter notebook
```
### Alternative : Using "yarn" and "npm" over "mamba"
Copy link
Member

@jtpio jtpio Oct 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even with mamba, we still need to use yarn or npm to work with the JavaScript dependencies.

So maybe there could be a mention to creating environment venv after the mamba instructions, instead of repeating everything?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @jtpio,

Thank you for your valuable feedback. I've addressed your comments and made the necessary changes to the documentation. You can find the new commit related to this feedback here: Updated CONTRIBUTING.md.

Please review the updated changes at your convenience. If everything looks good, I kindly request that you consider merging the pull request. If there are any further suggestions or if you have any concerns, please don't hesitate to let me know. Your feedback is greatly appreciated, and I'm here to ensure the documentation aligns with the project's standards.

Thanks again for your time and assistance.

Best regards,
Navdeep

Comment on lines +35 to +38
```bash
python -m venv venv
source venv/bin/activate # On Windows, use: venv\Scripts\activate
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can keep only this addition, and put it under this line:

Note: we recommend using mamba to speed the creating of the environment.

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
2 participants