Skip to content

Commit 5d337d0

Browse files
committed
Enhance sentence clarity and structure in CONTRIBUTING.md
1 parent 10425c2 commit 5d337d0

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ for a friendly and welcoming collaborative environment.
77

88
## Setting up a development environment
99

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.
1111

1212
The `jlpm` command is JupyterLab's pinned version of [yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
1313
`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
4747
jlpm watch
4848
```
4949

50-
To make sure the `notebook` server extension is installed:
50+
To make sure the `notebook` server extension is enabled:
5151

5252
```bash
5353
$ jupyter server extension list
@@ -82,12 +82,12 @@ Notebook, acting as a local package repository.
8282

8383
- Install yalc globally in your environment:
8484
`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`\
8787
For instance, if you are developing on _@jupyterlab/ui-components_, this command must be executed from
8888
_path_to_jupyterlab/packages/ui-components_.
8989
- Depend on this local repository in Notebook:
90-
- from the Notebook root directory:\
90+
- From the Notebook root directory:\
9191
`yalc add your_package` : this will create a _dependencies_ entry in the main _package.json_ file.\
9292
With the previous example, it would be `yalc add @jupyterlab/ui-components`.
9393
- 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.
9999
Changes in the dependency must then be built and pushed using `jlpm build && yalc push` (from the package root directory),
100100
and fetched from Notebook using `yarn install`.
101101

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.\
104104
In the previous example, both _@jupyterlab/ui-components_ and Notebook depend on _@jupyterlab/coreutils_. We
105105
strongly advise you to depend on the same version.
106106

@@ -206,10 +206,9 @@ into your text editor to format code automatically.
206206

207207
If you have already committed files before setting up the pre-commit
208208
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.
211210

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`,
213212
`yarn prettier`, or `jlpm prettier`) to format the entire code base.
214213
We recommend installing a Prettier extension for your code editor and
215214
configuring it to format your code with a keyboard shortcut, or
@@ -222,7 +221,7 @@ running with the `--hook-stage manual` argument.
222221

223222
First, make sure you have set up a development environment as described above.
224223

225-
Then run the following command to build the docs:
224+
Run the following command to build the docs:
226225

227226
```shell
228227
hatch run docs:build
@@ -238,9 +237,9 @@ Now, open a web browser and navigate to `http://localhost:8000` to access the do
238237

239238
## Contributing from the browser
240239

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:
242241

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:
244243
- Run `pixi shell` in a terminal to activate the development environment.
245244
- Use the commands above for building the extension and running the tests, for example: `jlpm build`
246245
- 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

Comments
 (0)