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

added instructions for installation and use of the cspell npm packag… #5905

Merged

Conversation

robertnjenga
Copy link
Member

@robertnjenga robertnjenga commented Nov 14, 2023

Fixes #5652

What changes did you make?

  • In CONTRIBUTING.md, section 1.7, added instructions for local codebase spell checking for users who do not use VSCode.

Why did you make the changes (we will use this info to test)?

  • To provide guidance for use of the npm package, cspell for developers who do not use VSCode.

For Reviewers:

Screenshots of Proposed Changes Of The Website (if any, please do not screen shot code changes)

  • No visual changes

Copy link

Want to review this pull request? Take a look at this documentation for a step by step guide!

From your project repository, check out a new branch and test the changes.

git checkout -b robertnjenga-workstation-spell-check-5652 gh-pages
git pull https://github.com/robertnjenga/website.git workstation-spell-check-5652

Note that CONTRIBUTING.md cannot previewed locally; rather it should be previewed at this URL:

https://github.com/robertnjenga/website/blob/workstation-spell-check-5652/CONTRIBUTING.md  

@roslynwythe roslynwythe self-requested a review November 15, 2023 01:21
Copy link
Member

@roslynwythe roslynwythe left a comment

Choose a reason for hiding this comment

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

Thank you @robertnjenga for submitting this pull request. You have setup the branches correctly, made clean updates, described your work, and provided a test URL for reviewers. I just have two requests:

  • Please shorten the title of the PR. Since it is so long, it is wrapping into the body of the PR.
  • Regarding the sentence "Feel free to reach out in the Hack for LA Slack channel if you have trouble installing docker on your system", I suggest making that sentence a new paragraph and changing it to ""Feel free to reach out in the Hack for LA Slack channel if you have trouble installing the VSCode extension or the cspell npm package on your system."

@KyleA99 KyleA99 self-requested a review November 15, 2023 02:25
@KyleA99
Copy link
Member

KyleA99 commented Nov 15, 2023

Review ETA: 7:30 PM 11/14/23
Availability: 6:30-8 PM Tuesday

Copy link
Member

@KyleA99 KyleA99 left a comment

Choose a reason for hiding this comment

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

@robertnjenga I left a few inline comments for minor typo fixes. Other than that, your changes look great. PR is on the correct branch and all of the links are correct. Great work!

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@robertnjenga robertnjenga requested a review from KyleA99 November 15, 2023 03:20
Copy link
Member

@roslynwythe roslynwythe left a comment

Choose a reason for hiding this comment

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

Great job @robertnjenga. Your branches are setup correctly, the PR is descriptive, and the changes to CONTRIBUTING.md look great. I have to apologize: the "VSCode" typo was my fault entirely. Thank you for fixing it and thanks to @KyleA99 for spotting it.

Copy link
Member

@KyleA99 KyleA99 left a comment

Choose a reason for hiding this comment

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

Looks great, nice work @robertnjenga :)

@robertnjenga
Copy link
Member Author

Thank You @roslynwythe and @KyleA99!

@kwangric kwangric merged commit 7d9132a into hackforla:gh-pages Nov 15, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add instructions for workstation spell checking using npm package
4 participants