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
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 17 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ for a friendly and welcoming collaborative environment.
Note: You will need NodeJS to build the extension package.

The `jlpm` command is JupyterLab's pinned version of [yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.
`yarn` or `npm`, in lieu of `jlpm` below.

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

Expand All @@ -30,9 +30,24 @@ jlpm develop
# Enable the server extension
jupyter server extension enable notebook
```
### Set Up a Python Virtual Environment:
As the Jupyter Notebook includes a Jupyter Server extension written in Python, it's recommended to create a virtual environment. You can use the `venv` module for this:
```bash
python -m venv venv
source venv/bin/activate # On Windows, use: venv\Scripts\activate
```
Comment on lines +35 to +38
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.

After setting up the environment (either with mamba or venv), you'll need to handle the JavaScript dependencies:

Install NodeJS Dependencies:
If you're using `yarn`:
```bash
yarn install
```
If you're using `npm`:
```bash
npm install
```
`notebook` follows a monorepo structure. To build all the packages at once:

```bash
jlpm build
```
Expand Down