website icon indicating copy to clipboard operation
website copied to clipboard

Run VS Code Spell Checker on _data/internal/communities/ops.yml

Open roslynwythe opened this issue 1 year ago • 2 comments

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 spreadsheet[^1] and will be resolved in later issues.

Action Items

  • [x] You must use VS Code as your local text editor and install the Code Spell Checker VS Code extension[^2]
  • [x] Do not change any configuration settings or make any spell corrections
  • [x] Open the file '_data/internal/communities/ops.yml' and note any Code Spell Checker errors
  • [x] 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.
  • [x] If at least one error was reported, copy/paste each cSpell message into a separate row in the Results sheet
  • [x] 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).
  • [x] Move this issue to the Questions/In Review column and apply the label ready for dev lead

Merge Team

  • [ ] After this issue is closed, release the dependency on this issue in #5248
  • [ ] After the last dependency has been released, close that issue

Resources/Instructions

  • This issue is part of #5248 [^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. For developers who do not use VS Code, use the corresponding npm package, cspell. Those instructions can be found at https://www.npmjs.com/package/cspell

roslynwythe avatar Jan 10 '24 18:01 roslynwythe

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

github-actions[bot] avatar Mar 12 '24 07:03 github-actions[bot]

i. Available to work on this issue every 2 days until estimated completion date ii. Expected to have this issue completed by March 21; first progress update to be issued at minimum by March 16

das-mittel avatar Mar 12 '24 07:03 das-mittel

Hi @das-mittel! Great job moving this issue to the correct column and adding the correct label. On my end I am seeing 6 errors and they are different from the error that you added. I believe this is because your local gh-pages is behind Hack for LA's. Please make sure you've pulled the current upstream gh-pages and add update the results page on the spreadsheet. When you're finished, you can move the issue back to the Questions / In Review column and add the ready for dev lead label. Thank you for working on this issue!

LRenDO avatar Mar 20 '24 23:03 LRenDO

Hi @das-mittel! Great job moving this issue to the correct column and adding the correct label. On my end I am seeing 6 errors and they are different from the error that you added. I believe this is because your local gh-pages is behind Hack for LA's. Please make sure you've pulled the current upstream gh-pages and add update the results page on the spreadsheet. When you're finished, you can move the issue back to the Questions / In Review column and add the ready for dev lead label. Thank you for working on this issue!

Thank you very much for reviewing the issue! I will look over the results once more and resubmit upon completion

i. Available to work on this issue every 2 days until estimated completion date ii. Expected to have this issue completed by March 27

das-mittel avatar Mar 21 '24 00:03 das-mittel

Hi @das-mittel! Great job with this issue! It looks like the same errors on this page are on my end too! You also did a great job with moving the issue to the right column and adding the correct label. Thanks for contributing to this epic!

LRenDO avatar Apr 04 '24 01:04 LRenDO