Skip to content
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

[#2082] Fix typo in command in Setting Up page #2083

Merged
merged 2 commits into from
Jan 26, 2024

Conversation

supermii2
Copy link
Contributor

@supermii2 supermii2 commented Jan 20, 2024

Fixes #2082

Replace the command `npm -v` with `node -v`.
This displays the node version instead of the npm version.

Copy link
Contributor

@asdfghjkxd asdfghjkxd left a comment

Choose a reason for hiding this comment

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

LGTM, node -v appears to show the installed node version!

@asdfghjkxd asdfghjkxd requested a review from a team January 20, 2024 05:28
Copy link
Contributor

@sopa301 sopa301 left a comment

Choose a reason for hiding this comment

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

LGTM

@jonasongg
Copy link
Contributor

Might want to change "Replaced" to "Replace" for the commit message!

@supermii2
Copy link
Contributor Author

Might want to change "Replaced" to "Replace" for the commit message!

Edited! Thank you!

@sopa301 sopa301 requested a review from a team January 22, 2024 12:33
Copy link
Member

@ckcherry23 ckcherry23 left a comment

Choose a reason for hiding this comment

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

Thanks @supermii2 for reporting and fixing this issue in the docs! Fixing such issues is very useful for future first-time contributors to get started easily.

@ckcherry23 ckcherry23 requested a review from a team January 22, 2024 13:58
Copy link
Contributor

@vvidday vvidday left a comment

Choose a reason for hiding this comment

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

Nice catch!

Minor thing about the commit message body: try to follow the recommended format (more details)

{current situation} -- use present tense

{why it needs to change}

{what is being done about it} -- use imperative mood

{why it is done that way}

{any other relevant info}

Some parts might seem obvious/redundant especially for smaller changes, but it's good to develop the habit for future PRs. For example, the body could be:

Fix typo in Setting Up page

The command given in the developer guide for checking the local Node.js
version is `npm -v`, which displays the version of npm instead.

Let's replace the command with `node -v`, which correctly displays the
Node.js version.

@ckcherry23 ckcherry23 merged commit 3cd680c into reposense:master Jan 26, 2024
10 checks passed
Copy link
Contributor

The following links are for previewing this pull request:

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.

Fix typo in command in Setting Up page
6 participants