-
Notifications
You must be signed in to change notification settings - Fork 5k
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
Update CONTRIBUTING.md #7473
base: main
Are you sure you want to change the base?
Update CONTRIBUTING.md #7473
Conversation
Updated the filed with typos and correct grammar
Hello anyone there |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you are human, thank you for contributing. Please appreciate that PRs reviews are often done in free time of volunteers and there is no need to ping back after just 24 hours.
On the PR itself, I am not convinced on most of these suggestions.
@@ -1,6 +1,6 @@ | |||
# Contributing to Jupyter Notebook | |||
|
|||
Thanks for contributing to Jupyter Notebook! | |||
Thanks for showing interest on contributing to Jupyter Notebook! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sounds like bad grammar to me, there is only one result on Google for "Thanks for showing interest on contributing to".
@@ -72,7 +72,7 @@ jupyter notebook | |||
|
|||
### Local changes in Notebook dependencies | |||
|
|||
The development installation described above fetches JavaScript dependencies from [npmjs](https://www.npmjs.com/), | |||
The developmental installations described above fetches JavaScript dependencies from [npmjs](https://www.npmjs.com/), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Both "developmental" and "installations" sound incorrect in this context.
@@ -199,8 +199,8 @@ You can invoke the pre-commit hook by hand at any time with: | |||
pre-commit run | |||
``` | |||
|
|||
which should run any autoformatting on your code | |||
and tell you about any errors it couldn't fix automatically. | |||
Which should run any autoformatting on your code |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is continuation of previous sentence so was right to my eye
@@ -92,7 +92,7 @@ Notebook, acting as a local package repository. | |||
With the previous example, it would be `yalc add @jupyterlab/ui-components`. | |||
- Notebook is a monerepo, so we want this dependency to be 'linked' as a resolution (for all sub-packages) instead | |||
of a dependency.\ | |||
The easiest way is to manually move the new entry in _package.json_ from _dependencies_ to _resolutions_. | |||
The easiest way is to do it is manually move the new entry in _package.json_ from _dependencies_ to _resolutions_. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The existing text sounds fine to me.
Updated the filed with typos and correct grammar