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

Fix spelling errors on guide pages and CONTRIBUTING.md #3994

Merged
merged 3 commits into from
Feb 21, 2023

Conversation

christinaor
Copy link
Member

Fixes #3546

What changes did you make and why did you make them ?

  • Fixed spelling errors on 2 guide pages using Code Spell Checker VS Code extension and manual checking in CONTRIBUTING.md, both in issue Identify all mispelled words on site and make issues to fix #2401 .
  • Researched linters/VS Code extensions and used Code Spell Checker to fix all but one error - does not detect words with less than 4 characters.

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

Visuals before changes are applied

image

image

image

Visuals after changes are applied

image

image

image

@github-actions
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 christinaor-spell-check-site-3546 gh-pages
git pull https://github.com/christinaor/website.git spell-check-site-3546

@github-actions github-actions bot added role: back end/devOps Tasks for back-end developers Complexity: Medium time sensitive Needs to be worked on by a particular timeframe Feature: Board/GitHub Maintenance Project board maintenance that we have to do repeatedly size: 3pt Can be done in 13-18 hours labels Feb 17, 2023
@christinaor christinaor changed the title Fix spelling errors Fix spelling errors on guide pages and CONTRIBUTING.md Feb 17, 2023
@vanessavun vanessavun self-requested a review February 17, 2023 05:28
@vanessavun
Copy link
Member

Availability: weekday evenings
ETA: 10PM 2/17

vanessavun
vanessavun previously approved these changes Feb 17, 2023
Copy link
Member

@vanessavun vanessavun left a comment

Choose a reason for hiding this comment

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

Thanks for fixing the spelling errors and great work for doing all the requirements. Based on the Google spreadsheet mentioned in the issue (6 misspelled words), I do see the 6 fixed spellings in the 3 total files you edited. I also checked the website in the local environment and all fixes are reflected and there is nothing broken that I can find.

(I'm noticing that the "elipsis" in the image class is misspelled, but it is not part of the fix and it's probably for another issue since it's maybe for styling.)

Copy link
Member

@t-will-gillis t-will-gillis left a comment

Choose a reason for hiding this comment

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

Hi @christinaor - great job exploring this topic. I was able to install the Code Spell Checker for VS Code locally to test how it works. I did see that it identifies the misspelled words from the design team’s list so that these may be corrected. It appears that if we went this route we would need to add/ignore common terms like ‘WCAG’ and ‘hackforLA’, as well as terms such as ‘inclusivity’ since these are coming up alongside the misspellings. I also confirmed that the linter is available but I did not install/test that locally because: a.) we still don’t know if this is the spell checker we will ultimately use and b.) I did not want to run this on my machine. If HfLA decides the VS Code Spell Checker is the direction to go, I think at that time the linter can be checked again to confirm it does what we want it to.

From my understanding, you satisfied the specific items listed in the topic including exploring the options and identifying a workable spell checker plugin/ linter, and you fixed the specific spelling errors from the design team’s list. You have also identified a Plan of Action with several further steps.

Excellent job!

@t-will-gillis t-will-gillis self-requested a review February 20, 2023 05:34
Copy link
Member

@t-will-gillis t-will-gillis left a comment

Choose a reason for hiding this comment

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

Hello again @christinaor -

There is an issue with your CONTRIBUTING.md that interestingly enough is not being flagged as a change in the 'Files Changed': The address on line 223 should be: https://github.com/hackforla/website/wiki/Add-local-user-accounts-to-the-docker-users-group-on-Windows-10 : Your copy says ...wiki/Adding-local-users... and it should be ...wiki/Add-local-users...

Would you please fix? Thanks!

@t-will-gillis t-will-gillis self-requested a review February 21, 2023 00:50
@christinaor
Copy link
Member Author

@t-will-gillis Thanks for catching that! Not sure why the link was different, but the PR has been updated with the correct link.

Copy link
Member

@t-will-gillis t-will-gillis left a comment

Choose a reason for hiding this comment

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

My apologies @christinaor - The reason that the link was different between your copy and the HFLA copy of CONTRIBUTING.md was b/c of a different PR (3995) submitted after you submitted your PR- it was not anything you did!

Thanks for changing though!

@t-will-gillis t-will-gillis merged commit 40a2c81 into hackforla:gh-pages Feb 21, 2023
@christinaor christinaor deleted the spell-check-site-3546 branch February 21, 2023 02:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Medium Feature: Board/GitHub Maintenance Project board maintenance that we have to do repeatedly role: back end/devOps Tasks for back-end developers size: 3pt Can be done in 13-18 hours time sensitive Needs to be worked on by a particular timeframe
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Find Linter and Matching VS Code Plugin to Spell Check Site
3 participants