Decision Record: VS Code Spell Checker Extension

[jdingeman]

Overview

We need to create a Decision Record so that we have the history of why & how we are using this spelling linter so that people in the future can understand it.

Action Items

• We are currently in the process of moving the old wiki to the new website-wiki repo, so we will not be making any changes or additions to the old wiki at this time. Thus, we will be adding wiki content through a different process now. Read How to Contribute to the Wiki

Action Items to be completed when new wiki is ready

• Create a new Decision Record in Solutions Adopted
• Follow the template to document this choice
• Be sure to include the following in your decision record:
  • Why we are using the linter
  • Why specifically this linter and what the requirements were
    • See comments in Find Linter and Matching VS Code Plugin to Spell Check Site #3546
  • Link to the extension for developers to install
  • Link to issue Create a Roll Out Plan for adding Code Spell Checker VS Code Extension #4349
  • Steps being taken to implement the linter across the team
  • Guidance on what has worked and what hasn't
    • This guidance should consider plans for implementing other local linters at a later time
• Add a link to the DR in Solutions Adopted
• Update the main Decision Records page with a link to the new DR preceded by a ✅
• Present your record to Product and Dev Leads Team for approval

For Merge Team/Dev Leads/PM

• When the DR has been accepted, release dependency on Create a Roll Out Plan for adding Code Spell Checker VS Code Extension #4349. If all dependencies have been satisfied, move that issue into the New Issue Approval column with the ready for dev lead or ready for product label for review and a note about where to find the finished plan.

Resources

• Decision Records on Solutions Adopted
• Code Spell Checker as a local linter

Decision Record Template

This is a record in the [Decision Records on Solutions Adopted](https://github.com/hackforla/website/wiki/Decision-Records-on-Solutions-Adopted).

#### Issue 
#### Problem Statement
#### Potential Solution
#### Feasibility Determination

[github-actions]

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

[amath95]

Availability: 05/07
ETA: 05/12

[github-actions]

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

[LRenDO]

Availability: 6/9/23 11:30-3pm
ETA: 3pm

[LRenDO]

DR: VS Code Spell Checker Extension

This is a record in the Decision Records on Solutions Adopted.

Issue

#4471

Problem Statement

Preventing misspellings on our website.

Potential Solution

Using a spell check plugin and linter to ensure correct spelling.

Feasibility Determination

It was decided that we would use a linter to ensure correct spelling. The linter chosen was Code Spell Checker. More details for reasoning can be found in #3546.

Summary of reasoning for choosing Code Spell Checker:

• Can be used by developers that do not use VS Code
• Most other linters note their dictionaries might not be accurate and Code Spell Checker is the most current
• Can be used with GHA and locally with either VS Code plugin or npm package

Installation Resources

Resources from #3546:

• Installation instructions for the Code Spell Checker VS Code extension
• FAQ on using Code Spell Checker as a linter or part of the build process
• Instructions for npm package installation for cspell

Roll Out Plan

The roll out plan including the steps being taken to roll out across the team can be found in #4349.

Plan Summary:

• Update CONTRIBUTING.md wiki
• Add decision record
• Add GitHub Actions messages to pull requests and prework issues
• Create slides for developer and onboarding meeting messaging
• Messaging to developer team on slack

Future Plans

Guidance advised for future plans:

• Creating a new issue for a linter to address grammar issues, as Code Spell Checker only checks spelling
• Finding a solution that checks words of 3 letters or less in the future, as Code Spell Checker only checks words that are at least 4 characters

[LRenDO]

Hi @jdingeman, @roslynwythe, @t-will-gillis, and @blulady!

I completed the Decision Record in the comment above. Please let me know if there are any changes you'd like or if I should loop someone else in as well. Thanks!

[LRenDO]

Hi @jdingeman, @roslynwythe, @t-will-gillis, and @blulady!

Pinging folks again since I haven't heard anything yet. The Decision Record above is ready for review. Please let me know if there are any changes you'd like. Thanks!

[LRenDO]

Progress Update
Work complete. Awaiting review.

[roslynwythe]

Hi @LRenDO This looks good to me, although I think under "Issue", you should list "#4471" since that is the issue for which you wrote the DR. There is no team meeting on Sunday 7/2 so I will put it on the agenda for the PM/Dev Lead meeting on Monday 7/3, but Bonnie may want to discuss it with you at the 7/9 all-team meeting.

[LRenDO]

Hi @LRenDO This looks good to me, although I think under "Issue", you should list "#4471" since that is the issue for which you wrote the DR. There is no team meeting on Sunday 7/2 so I will put it on the agenda for the PM/Dev Lead meeting on Monday 7/3, but Bonnie may want to discuss it with you at the 7/9 all-team meeting.

Thanks for the update, @roslynwythe and good catch on the issue number! I've updated it in the comment with the DR.

[LRenDO]

At the July 9th meeting, PM @wanyuguan approved closing this issue. @roslynwythe / @hackforla/website-merge will close the issue.