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 sdg11.yml #6574

Closed
8 of 9 tasks
Tracked by #5248 ...
lukewangm opened this issue Apr 5, 2024 · 3 comments
Closed
8 of 9 tasks
Tracked by #5248 ...

Run VS Code Spell Checker on sdg11.yml #6574

lukewangm opened this issue Apr 5, 2024 · 3 comments
Assignees
Labels
Complexity: Small Take this type of issues after the successful merge of your second good first issue feature: spelling ready for dev lead Issues that tech leads or merge team members need to follow up on 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

@lukewangm
Copy link
Member

lukewangm commented Apr 5, 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 '_data/internal/sdg/sdg11.yml' and note any Code Spell Checker errors
  • Locate the file in column A ("File") 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.

@lukewangm lukewangm 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 Apr 5, 2024
@ExperimentsInHonesty ExperimentsInHonesty added feature: spelling and removed Feature: Administrative Administrative chores etc. labels Apr 10, 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 Apr 16, 2024
@roslynwythe roslynwythe added this to the x. Technical debt milestone Apr 21, 2024
@del9ra del9ra self-assigned this May 18, 2024
Copy link

Hi @del9ra, 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 :)

@del9ra
Copy link
Member

del9ra commented May 20, 2024

Availability: May 20, 1PM-6PM
My estimated ETA for completing this issue: May 21, 10PM

@del9ra del9ra added the ready for dev lead Issues that tech leads or merge team members need to follow up on label May 20, 2024
@Thinking-Panda
Copy link
Member

Thank you @del9ra for spell checking the page and recording your results in the spreadsheet.

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: spelling ready for dev lead Issues that tech leads or merge team members need to follow up on 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

Successfully merging a pull request may close this issue.

6 participants