Skip to content

Improve grammar and consistency in CONTRIBUTING.md #7652

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

lejenhan
Copy link

This PR improves the CONTRIBUTING.md file to enhance readability by:

  • Fixing grammatical issues
  • Ensuring consistent capitalization of tool names and code comments
  • Improving sentence consistency and clarity

It follows up on the closed PR #7645, addressing similar grammatical issues with additional fixes. Please let me know if any additional changes are needed, thank you!

Copy link
Contributor

Binder 👈 Launch a Binder on branch lejenhan/notebook/doc_update

Copy link

@Muazislam Muazislam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@@ -7,18 +7,17 @@ for a friendly and welcoming collaborative environment.

Setting up a development environment

-Note: You will need NodeJS to build the extension package.
-Note: you will need Node.js to build the extension package.
+Note: You will need Node.js to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use
yarn or npm in lieu of jlpm below.

-Note: we recommend using mamba to speed the creating of the environment.
+Note: We recommend using mamba to accelerate the creation of the environment.

-# create a new environment
+# Create a new environment
mamba create -n notebook -c conda-forge python nodejs -y

-# activate the environment
+# Activate the environment
mamba activate notebook

# Install package in development mode
@@ -74,8 +73,8 @@ jupyter notebook

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

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

```bash
cd ui-tests
-#install required packages for jlpm
-jlpm
+# Install required packages using jlpm
+jlpm

-#install playwright
-# Install Playwright
+# Install Playwright
jlpm playwright install

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

-# in a new terminal, run the tests
+# In a new terminal, run the tests
jlpm test

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants