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 _data/internal/communities/engineering.yml #6094

Closed
8 of 9 tasks
Tracked by #5248
roslynwythe opened this issue Jan 10, 2024 · 2 comments
Closed
8 of 9 tasks
Tracked by #5248
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

@roslynwythe
Copy link
Member

roslynwythe commented Jan 10, 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/communities/engineering.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. 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 roslynwythe 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 and removed Feature: Administrative Administrative chores etc. ready for dev lead Issues that tech leads or merge team members need to follow up on labels Jan 10, 2024
@github-actions github-actions bot added Feature: Administrative Administrative chores etc. ready for dev lead Issues that tech leads or merge team members need to follow up on labels Jan 10, 2024
@roslynwythe roslynwythe added feature: spelling and removed Feature: Administrative Administrative chores etc. ready for dev lead Issues that tech leads or merge team members need to follow up on labels Jan 10, 2024
@roslynwythe roslynwythe added this to the x. Technical debt milestone Jan 10, 2024
@kmdeakers kmdeakers self-assigned this Mar 20, 2024
Copy link

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

@kmdeakers kmdeakers added the ready for dev lead Issues that tech leads or merge team members need to follow up on label Mar 20, 2024
@LRenDO
Copy link
Member

LRenDO commented Mar 20, 2024

Hi @kmdeakers! Great job with this issue! It looks like the same errors 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 LRenDO closed this as completed Mar 20, 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: 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
Projects
Development

No branches or pull requests

3 participants