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/press/gov_tech.yml #6494

Closed
7 of 9 tasks
Tracked by #5248
roslynwythe opened this issue Mar 21, 2024 · 4 comments
Closed
7 of 9 tasks
Tracked by #5248

Run VS Code Spell Checker on _data/internal/press/gov_tech.yml #6494

roslynwythe opened this issue Mar 21, 2024 · 4 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

@roslynwythe
Copy link
Member

roslynwythe commented Mar 21, 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/press/gov_tech.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.

@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 size: 0.5pt Can be done in 3 hours or less labels Mar 21, 2024
@roslynwythe roslynwythe added this to the x. Technical debt milestone Mar 21, 2024
@ExperimentsInHonesty ExperimentsInHonesty added feature: spelling and removed Feature: Administrative Administrative chores etc. labels Apr 10, 2024
@raviteja4117 raviteja4117 self-assigned this Apr 16, 2024
Copy link

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

@raviteja4117
Copy link
Member

Hi

i. Availability: Mon to Sun 11:00 AM to 9:00 PM EST
ii. ETA: Friday this week

@ExperimentsInHonesty
Copy link
Member

@raviteja4117 I will move this issue the in progress column, but in future, you should do that when you self assign.

@raviteja4117 raviteja4117 added the ready for dev lead Issues that tech leads or merge team members need to follow up on label Apr 24, 2024
@roslynwythe
Copy link
Member Author

Thank you @raviteja4117 for completing the spell check 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
Projects
Archived in project
Development

No branches or pull requests

3 participants