Skip to content

Commit b1a5f61

Browse files
authored
Update CONTRIBUTING.md (jupyter#7645)
Corrected typos and fixed grammar.
1 parent 1d9dbd3 commit b1a5f61

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -80,17 +80,17 @@ been published.
8080
[yalc](https://github.com/wclr/yalc) can help use local JavaScript packages in your build of
8181
Notebook, acting as a local package repository.
8282

83-
- Install yalc globally in you environment:
83+
- Install yalc globally in your environment:
8484
`npm install -g yalc`
85-
- Publish you dependency package:\
85+
- Publish your dependency package:\
8686
`yalc publish`, from the package root directory.\
87-
For instance, if you have are developing on _@jupyterlab/ui-components_, this command must be executed from
87+
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:
9090
- 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`.
93-
- Notebook is a monerepo, so we want this dependency to be 'linked' as a resolution (for all sub-packages) instead
93+
- Notebook is a monorepo, so we want this dependency to be 'linked' as a resolution (for all sub-packages) instead
9494
of a dependency.\
9595
The easiest way is to manually move the new entry in _package.json_ from _dependencies_ to _resolutions_.
9696
- Build Notebook with the local dependency:\
@@ -132,11 +132,11 @@ jlpm test
132132

133133
The `test` script calls the Playwright test runner. You can pass additional arguments to `playwright` by appending parameters to the command. For example to run the test in headed mode, `jlpm test --headed`.
134134

135-
Checkout the [Playwright Command Line Reference](https://playwright.dev/docs/test-cli/) for more information about the available command line options.
135+
Check out the [Playwright Command Line Reference](https://playwright.dev/docs/test-cli/) for more information about the available command line options.
136136

137137
Running the end to end tests in headful mode will trigger something like the following:
138138

139-
![playwight-headed-demo](https://user-images.githubusercontent.com/591645/141274633-ca9f9c2f-eef6-430e-9228-a35827f8133d.gif)
139+
![playwright-headed-demo](https://user-images.githubusercontent.com/591645/141274633-ca9f9c2f-eef6-430e-9228-a35827f8133d.gif)
140140

141141
## Tasks caching
142142

@@ -173,7 +173,7 @@ This will trigger a GitHub Action that will run the UI tests automatically and p
173173

174174
## Code Styling
175175

176-
All non-python source code is formatted using [prettier](https://prettier.io) and python source code is formatted using [black](https://github.com/psf/black)s
176+
All non-python source code is formatted using [prettier](https://prettier.io) and python source code is formatted using [black](https://github.com/psf/black).
177177
When code is modified and committed, all staged files will be
178178
automatically formatted using pre-commit git hooks (with help from
179179
[pre-commit](https://github.com/pre-commit/pre-commit). The benefit of
@@ -212,7 +212,7 @@ yourself after that.
212212
You may also use the prettier npm script (e.g. `npm run prettier` or
213213
`yarn prettier` or `jlpm prettier`) to format the entire code base.
214214
We recommend installing a prettier extension for your code editor and
215-
configuring it to format your code with a keyboard shortcut or
215+
configuring it to format your code with a keyboard shortcut, or
216216
automatically on save.
217217

218218
Some of the hooks only run on CI by default, but you can invoke them by
@@ -245,5 +245,5 @@ Alternatively you can also contribute to Jupyter Notebook without setting up a l
245245
- Use the commands above for building the extension and running the tests, for example: `jlpm build`
246246
- 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.
247247
- [Gitpod](https://gitpod.io/#https://github.com/jupyter/notebook) integration is enabled. The Gitpod config automatically builds the Jupyter Notebook application and the documentation.
248-
- GitHub’s [built-in editor](https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files) is suitable for contributing small fixes
248+
- GitHub’s [built-in editor](https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files) is suitable for contributing small fixes.
249249
- A more advanced [github.dev](https://docs.github.com/en/codespaces/the-githubdev-web-based-editor) editor can be accessed by pressing the dot (.) key while in the Jupyter Notebook GitHub repository

0 commit comments

Comments
 (0)