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
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -80,17 +80,17 @@ been published.
80
80
[yalc](https://github.com/wclr/yalc) can help use local JavaScript packages in your build of
81
81
Notebook, acting as a local package repository.
82
82
83
-
- Install yalc globally in you environment:
83
+
- Install yalc globally in your environment:
84
84
`npm install -g yalc`
85
-
- Publish you dependency package:\
85
+
- Publish your dependency package:\
86
86
`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
88
88
_path_to_jupyterlab/packages/ui-components_.
89
89
- Depend on this local repository in Notebook:
90
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
-
- 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
94
94
of a dependency.\
95
95
The easiest way is to manually move the new entry in _package.json_ from _dependencies_ to _resolutions_.
96
96
- Build Notebook with the local dependency:\
@@ -132,11 +132,11 @@ jlpm test
132
132
133
133
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`.
134
134
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.
136
136
137
137
Running the end to end tests in headful mode will trigger something like the following:
@@ -173,7 +173,7 @@ This will trigger a GitHub Action that will run the UI tests automatically and p
173
173
174
174
## Code Styling
175
175
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).
177
177
When code is modified and committed, all staged files will be
178
178
automatically formatted using pre-commit git hooks (with help from
179
179
[pre-commit](https://github.com/pre-commit/pre-commit). The benefit of
@@ -212,7 +212,7 @@ yourself after that.
212
212
You may also use the prettier npm script (e.g. `npm run prettier` or
213
213
`yarn prettier` or `jlpm prettier`) to format the entire code base.
214
214
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
216
216
automatically on save.
217
217
218
218
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
245
245
- Use the commands above for building the extension and running the tests, for example: `jlpm build`
246
246
- 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.
247
247
-[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.
249
249
- 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