-
Notifications
You must be signed in to change notification settings - Fork 5k
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
base: main
Are you sure you want to change the base?
Conversation
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
for more information, see https://pre-commit.ci
CONTRIBUTING.md
Outdated
```bash | ||
jupyter notebook | ||
``` | ||
### Alternative : Using "yarn" and "npm" over "mamba" |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
```bash | ||
python -m venv venv | ||
source venv/bin/activate # On Windows, use: venv\Scripts\activate | ||
``` |
There was a problem hiding this comment.
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.
Setting up a Development Environment using yarn and npm
Summary:
This pull request adds detailed instructions for setting up a development environment using
yarn
andnpm
in the CONTRIBUTING.md file. It provides an alternative method for contributors who prefer these tools overmamba
. 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:
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:
Additional Context:
Thank you for considering this pull request. I look forward to your feedback and the opportunity to improve the contributor experience.