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

Run VS Code Spell Checker on home-unite-us.md #7456

Closed
8 of 9 tasks
Tracked by #5248 ...
santisecco opened this issue Sep 14, 2024 · 7 comments
Closed
8 of 9 tasks
Tracked by #5248 ...

Run VS Code Spell Checker on home-unite-us.md #7456

santisecco opened this issue Sep 14, 2024 · 7 comments
Assignees
Labels
Complexity: Small Take this type of issues after the successful merge of your second good first issue Feature: Administrative Administrative chores etc. role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers size: 0.5pt Can be done in 3 hours or less

Comments

@santisecco
Copy link
Member

santisecco commented Sep 14, 2024

Overview

We need to audit HfLA codebase files for spelling errors using the Code Spell Checker extension in VS Code in order to ensure site quality. Results will be categorized as misspellings or false positives in the HfLA spelling audit spreadsheet1 and will be resolved in later issues.

Action Items

  • You must use VS Code as your local text editor and install the Code Spell Checker VS Code extension2
  • Do not change any configuration settings or make any spell corrections
  • Open the file '[_projects/home-unite-us.md' and note any Code Spell Checker errors
  • Locate the file in column A (named "Filepath") of the "Page Audit" sheet. In the column labeled "Result Summary", select the appropriate option: No errors or At least one error.
  • If at least one error was reported, copy/paste each cSpell message into a separate row in the Results sheet
  • In each new row, select the appropriate value: misspelling or false positive from the "Result type" column. A false positive is a term that is not a misspelling but is not recognized by the spell checker because it is a technical term, abbreviation, acronym, URL or proper noun (name of a person, place or organization).
  • Move this issue to the Questions/In Review column and apply the label ready for dev lead

Merge Team

Resources/Instructions

Footnotes

  1. HfLA spelling audit spreadsheet - Results

  2. The recommended installation method is to install Code Spell Checker directly from the VS Code text editor, and those instructions can be found here. The extension can also be installed via the VS Code Marketplace website here.

@santisecco santisecco added Feature: Administrative Administrative chores etc. role: front end Tasks for front end developers role: back end/devOps Tasks for back-end developers Complexity: Small Take this type of issues after the successful merge of your second good first issue ready for dev lead Issues that tech leads or merge team members need to follow up on size: 0.5pt Can be done in 3 hours or less labels Sep 14, 2024
@t-will-gillis t-will-gillis added Ready for Prioritization and removed ready for dev lead Issues that tech leads or merge team members need to follow up on labels Sep 14, 2024
@t-will-gillis t-will-gillis moved this to New Issue Approval in P: HfLA Website: Project Board Sep 14, 2024
@k-cardon k-cardon self-assigned this Sep 20, 2024
@HackforLABot

This comment was marked as outdated.

@HackforLABot
Copy link
Contributor

Hi @siyunfeng, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:-
i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?)
ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

@siyunfeng
Copy link
Member

Availability: 6:00 PM - 10:00 PM, Weekdays (EDT)
ETA: Sat, 10/19/2024

@siyunfeng siyunfeng moved this from Prioritized backlog to In progress (actively working) in P: HfLA Website: Project Board Oct 18, 2024
@siyunfeng siyunfeng moved this from In progress (actively working) to Questions / In Review in P: HfLA Website: Project Board Oct 18, 2024
@siyunfeng siyunfeng added the ready for dev lead Issues that tech leads or merge team members need to follow up on label Oct 18, 2024
@siyunfeng
Copy link
Member

siyunfeng commented Oct 18, 2024

Hi @santisecco ,
I have completed every step in Action Items.

cSpell Results:

  • "pdfs": Unknown word [In 129] - (False Positive)
  • "wireframes": Unknown word [In 134] - (False Positive)
  • "OIDC": Unknown word [In 145] - (False Positive)

Do I still need to submit a PR since it wasn't required to change anything in the _projects/home-unite-us.md file?

@t-will-gillis
Copy link
Member

Hi @siyunfeng No, you do not need to submit a PR- we will review this and get back to you. Thank you!

@santisecco
Copy link
Member Author

@siyunfeng check Will's comment, I believe merge team will review your work but from what I can see everything seems correct.

@t-will-gillis
Copy link
Member

Hey @siyunfeng Looks good- You noted that at least one error was found on the "Page Audit" sheet, and listed the three words that were flagged on the "Results" page.

Great job and thank you for working on this epic. I am closing this issue as successfully completed.

@github-project-automation github-project-automation bot moved this from Questions / In Review to QA in P: HfLA Website: Project Board Oct 21, 2024
@t-will-gillis t-will-gillis removed the ready for dev lead Issues that tech leads or merge team members need to follow up on label Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Small Take this type of issues after the successful merge of your second good first issue Feature: Administrative Administrative chores etc. role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers size: 0.5pt Can be done in 3 hours or less
Development

No branches or pull requests

6 participants