You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+12-13Lines changed: 12 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ for a friendly and welcoming collaborative environment.
7
7
8
8
## Setting up a development environment
9
9
10
-
**Note**: you will need Node.js to build the extension package.
10
+
**Note**: you will need Node.js installed to build the extension package.
11
11
12
12
The `jlpm` command is JupyterLab's pinned version of [yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
13
13
`yarn` or `npm` in lieu of `jlpm` below.
@@ -47,7 +47,7 @@ There is also a `watch` script to watch for changes and rebuild the app automati
47
47
jlpm watch
48
48
```
49
49
50
-
To make sure the `notebook` server extension is installed:
50
+
To make sure the `notebook` server extension is enabled:
51
51
52
52
```bash
53
53
$ jupyter server extension list
@@ -82,12 +82,12 @@ Notebook, acting as a local package repository.
82
82
83
83
- Install yalc globally in your environment:
84
84
`npm install -g yalc`
85
-
-Publish your dependency package:\
86
-
`yalc publish`, from the package root directory.\
85
+
-From the package root directory, publish your dependency package:\
86
+
`yalc publish`\
87
87
For instance, if you are developing on _@jupyterlab/ui-components_, this command must be executed from
88
88
_path_to_jupyterlab/packages/ui-components_.
89
89
- Depend on this local repository in Notebook:
90
-
-from the Notebook root directory:\
90
+
-From the Notebook root directory:\
91
91
`yalc add your_package` : this will create a _dependencies_ entry in the main _package.json_ file.\
92
92
With the previous example, it would be `yalc add @jupyterlab/ui-components`.
93
93
- Notebook is a monorepo, so we want this dependency to be 'linked' as a resolution (for all sub-packages) instead
@@ -99,8 +99,8 @@ Notebook, acting as a local package repository.
99
99
Changes in the dependency must then be built and pushed using `jlpm build && yalc push` (from the package root directory),
100
100
and fetched from Notebook using `yarn install`.
101
101
102
-
**Warning**: you need to make sure that the dependencies of Notebook and the local package match correctly,
103
-
otherwise there will be errors with webpack during build.\
102
+
**Warning**: you need to make sure that the dependencies of Notebook and the local package match correctly.
103
+
Otherwise, there will be errors with webpack during build.\
104
104
In the previous example, both _@jupyterlab/ui-components_ and Notebook depend on _@jupyterlab/coreutils_. We
105
105
strongly advise you to depend on the same version.
106
106
@@ -206,10 +206,9 @@ into your text editor to format code automatically.
206
206
207
207
If you have already committed files before setting up the pre-commit
208
208
hook with `pre-commit install`, you can fix everything up using
209
-
`pre-commit run --all-files`. You need to make the fixing commit
210
-
yourself after that.
209
+
`pre-commit run --all-files`. You'll need to commit the fixes manually after that.
211
210
212
-
You may also use the Prettier npm script (e.g., `npm run prettier`,
211
+
You may also run Prettier using a script (e.g., `npm run prettier`,
213
212
`yarn prettier`, or `jlpm prettier`) to format the entire code base.
214
213
We recommend installing a Prettier extension for your code editor and
215
214
configuring it to format your code with a keyboard shortcut, or
@@ -222,7 +221,7 @@ running with the `--hook-stage manual` argument.
222
221
223
222
First, make sure you have set up a development environment as described above.
224
223
225
-
Then run the following command to build the docs:
224
+
Run the following command to build the docs:
226
225
227
226
```shell
228
227
hatch run docs:build
@@ -238,9 +237,9 @@ Now, open a web browser and navigate to `http://localhost:8000` to access the do
238
237
239
238
## Contributing from the browser
240
239
241
-
Alternatively, you can also contribute to Jupyter Notebook without setting up a local environment, directly from a web browser:
240
+
Alternatively, you can contribute to Jupyter Notebook without setting up a local environment, directly from a web browser:
242
241
243
-
-[GitHub CodeSpaces](https://github.com/codespaces) is directly integrated into GitHub. This repository uses the [pixi](https://pixi.sh/) package manager to set up the development environment. To contribute after the Codespace is started:
242
+
-[GitHub CodeSpaces](https://github.com/codespaces) is directly integrated into GitHub. This repository uses the [Pixi](https://pixi.sh/) package manager to set up the development environment. To contribute after the Codespace is started:
244
243
- Run `pixi shell` in a terminal to activate the development environment.
245
244
- Use the commands above for building the extension and running the tests, for example: `jlpm build`
246
245
- To start the application: `pixi run start`. A popup should appear with a button to open the Jupyter Notebook in a new browser tab. If the popup does not appear, you can navigate to the "Forwarded ports" panel to find the URL to the application.
0 commit comments