Skip to content

Commit e0ff7c4

Browse files
committed
Fix grammar and improve consistency in CONTRIBUTING.md
1 parent b1a5f61 commit e0ff7c4

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

CONTRIBUTING.md

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

88
## Setting up a development environment
99

10-
Note: You will need NodeJS to build the extension package.
10+
**Note**: you will need Node.js 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.
1414

15-
**Note**: we recommend using `mamba` to speed the creating of the environment.
15+
**Note**: we recommend using `mamba` to speed up environment creation.
1616

1717
```bash
18-
# create a new environment
18+
# Create a new environment
1919
mamba create -n notebook -c conda-forge python nodejs -y
2020

21-
# activate the environment
21+
# Activate the environment
2222
mamba activate notebook
2323

2424
# Install package in development mode
@@ -74,7 +74,7 @@ jupyter notebook
7474

7575
The development installation described above fetches JavaScript dependencies from [npmjs](https://www.npmjs.com/),
7676
according to the versions in the _package.json_ file.
77-
However, it is sometimes useful to be able to test changes in Notebook, with dependencies (e.g. `@jupyterlab` packages) that have not yet
77+
However, it is sometimes useful to be able to test changes in Notebook, with dependencies (e.g., `@jupyterlab` packages) that have not yet
7878
been published.
7979

8080
[yalc](https://github.com/wclr/yalc) can help use local JavaScript packages in your build of
@@ -117,20 +117,20 @@ There are also end to end tests to cover higher level user interactions, located
117117

118118
```bash
119119
cd ui-tests
120-
#install required packages for jlpm
120+
# Install required packages for jlpm
121121
jlpm
122122

123-
#install playwright
123+
# Install Playwright
124124
jlpm playwright install
125125

126-
# start a new Jupyter server in a terminal
126+
# Start a new Jupyter server in a terminal
127127
jlpm start
128128

129-
# in a new terminal, run the tests
129+
# In a new terminal, run the tests
130130
jlpm test
131131
```
132132

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`.
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`.
134134

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

@@ -163,7 +163,7 @@ To learn more about Lerna caching:
163163

164164
Often a PR might make changes to the user interface, which can cause the visual regression tests to fail.
165165

166-
If you want to update the reference snapshots while working on a PR you can post the following sentence as a GitHub comment:
166+
If you want to update the reference snapshots while working on a PR, you can post the following sentence as a GitHub comment:
167167

168168
```
169169
bot please update playwright snapshots
@@ -173,11 +173,11 @@ 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).
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
178-
automatically formatted using pre-commit git hooks (with help from
178+
automatically formatted using pre-commit git hooks with help from
179179
[pre-commit](https://github.com/pre-commit/pre-commit). The benefit of
180-
using a code formatters like `prettier` and `black` is that it removes the topic of
180+
using code formatters like `prettier` and `black` is that it removes the topic of
181181
code style from the conversation when reviewing pull requests, thereby
182182
speeding up the review process.
183183

@@ -209,9 +209,9 @@ hook with `pre-commit install`, you can fix everything up using
209209
`pre-commit run --all-files`. You need to make the fixing commit
210210
yourself after that.
211211

212-
You may also use the prettier npm script (e.g. `npm run prettier` or
213-
`yarn prettier` or `jlpm prettier`) to format the entire code base.
214-
We recommend installing a prettier extension for your code editor and
212+
You may also use the Prettier npm script (e.g., `npm run prettier`,
213+
`yarn prettier`, or `jlpm prettier`) to format the entire code base.
214+
We recommend installing a Prettier extension for your code editor and
215215
configuring it to format your code with a keyboard shortcut, or
216216
automatically on save.
217217

@@ -238,12 +238,12 @@ Now open a web browser and navigate to `http://localhost:8000` to access the doc
238238

239239
## Contributing from the browser
240240

241-
Alternatively you can also contribute to Jupyter Notebook without setting up a local environment, directly from a web browser:
241+
Alternatively, you can also contribute to Jupyter Notebook without setting up a local environment, directly from a web browser:
242242

243243
- [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-
- Run `pixi shell` in a terminal to activate the development environment
244+
- Run `pixi shell` in a terminal to activate the development environment.
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.
248248
- 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-
- 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
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

Comments
 (0)