Skip to content

Commit df4f992

Browse files
Updated CONTRIBUTING.md based on PR feedback
1 parent 98a9d04 commit df4f992

File tree

1 file changed

+17
-43
lines changed

1 file changed

+17
-43
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ for a friendly and welcoming collaborative environment.
1010
Note: You will need NodeJS to build the extension package.
1111

1212
The `jlpm` command is JupyterLab's pinned version of [yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
13-
`yarn` or `npm` mentioned as an alternative, in lieu of `jlpm` below.
13+
`yarn` or `npm`, in lieu of `jlpm` below.
1414

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

@@ -30,9 +30,24 @@ jlpm develop
3030
# Enable the server extension
3131
jupyter server extension enable notebook
3232
```
33+
### Set Up a Python Virtual Environment:
34+
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:
35+
```bash
36+
python -m venv venv
37+
source venv/bin/activate # On Windows, use: venv\Scripts\activate
38+
```
39+
After setting up the environment (either with mamba or venv), you'll need to handle the JavaScript dependencies:
3340

41+
Install NodeJS Dependencies:
42+
If you're using `yarn`:
43+
```bash
44+
yarn install
45+
```
46+
If you're using `npm`:
47+
```bash
48+
npm install
49+
```
3450
`notebook` follows a monorepo structure. To build all the packages at once:
35-
3651
```bash
3752
jlpm build
3853
```
@@ -62,47 +77,6 @@ Config dir: /usr/local/etc/jupyter
6277

6378
Then start Jupyter Notebook with:
6479

65-
```bash
66-
jupyter notebook
67-
```
68-
### Alternative : Using "yarn" and "npm" over "mamba"
69-
70-
If you prefer using `yarn` or `npm` over `mamba`, you can follow these steps to set up your development environment:
71-
72-
Clone the Repository:
73-
```bash
74-
git clone https://github.com/jupyter/notebook.git
75-
cd notebook
76-
```
77-
78-
Install NodeJS Dependencies:
79-
If you're using `yarn`:
80-
```bash
81-
yarn install
82-
```
83-
If you're using `npm`:
84-
```bash
85-
npm install
86-
```
87-
### Set Up a Python Virtual Environment:
88-
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:
89-
```bash
90-
python -m venv venv
91-
source venv/bin/activate # On Windows, use: venv\Scripts\activate
92-
```
93-
Install Python Dependencies:
94-
```bash
95-
pip install -e ".[dev,test]"
96-
```
97-
Build the Notebook:
98-
```bash
99-
jlpm build
100-
```
101-
Enable the Server Extension:
102-
```bash
103-
jupyter server extension enable notebook
104-
```
105-
Start Jupyter Notebook:
10680
```bash
10781
jupyter notebook
10882
```

0 commit comments

Comments
 (0)