Skip to content

Add Code Spell Checker VS Code extension installation instructions #4101

@christinaor

Description

@christinaor

Dependency

Overview

As developers of the Hack for LA website, we want to align on the tools we're using to keep the codebase as free as possible of misspellings so our reputation and the quality of our code is maintained. For this issue, we will add installation instructions for the VS Code extension, Code Spell Checker, so our developers will be aligned on the local spellchecker used.

Action Items

  • In CONTRIBUTING.md, update the Table of Contents to include linkage to the Code Spell Checker installation process with the following:
    - [**1.7 Dev setup (7): Install local codebase spell checker**](#17-dev-setup-7-install-local-codebase-spell-checker)
  • In the same file, add the following instructions for the installation process:
### **1.7 Dev setup (7): Install local codebase spell checker**

You must use VS Code as your local text editor to install the VS Code extension for spell checking your codebase, Code Spell Checker.

The recommended installation method is to install Code Spell Checker directly from the VS Code text editor, and those instructions can be found [here](https://code.visualstudio.com/learn/get-started/extensions). The extension can also be installed via the VS Code Marketplace website [here](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker). <strong><em>Feel free to reach out in the [Hack for LA Slack channel](https://hackforla.slack.com/messages/hfla-site/) if you have trouble installing the extension in VS Code.</em></strong>
  • Changes to CONTRIBUTING.md cannot be tested locally, rather they must be tested after pushing the issue branch to your fork of the repository. Push your issue branch in the usual manner, but before creating the Pull Request, check your updates using this test URL. Also store the test URL for use in a later step:
https://github.com/[REPLACE WITH GITHUB HANDLE]/website/blob/[REPLACE WITH NAME OF ISSUE BRANCH]/CONTRIBUTING.md

(for example: https://github.com/bonniewolfe/website/blob/issue-branch-1234/CONTRIBUTING.md)

  • Ensure that the linkage from the first action item links correctly to the second action item's instructions.
  • Create a pull request in the usual manner, but after the "Why did you make the changes" section, add this line to help reviewers, replacing the text in brackets (and the brackets) with the test URL from the previous Action Item.
For Reviewers: Do not review changes locally, rather, review changes at [REPLACE WITH TEST URL]

Resources/Instructions

CONTRIBUTING.md
Getting started with writing and formatting on GitHub

Merge Team

  • After this issue is completed, change the instructions in the pre-work checklist from
Complete steps 1.1 - 1.6 in [Part 1: Setting up the development environment within Contributing.md]

to

Complete steps 1.1 - 1.7 in [Part 1: Setting up the development environment within Contributing.md]

Resources/Instructions

Related Issues

Metadata

Metadata

Assignees

Type

No type

Projects

Status

Done

Relationships

None yet

Development

No branches or pull requests

Issue actions