diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 941b3b8372..95fbccef72 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,6 +29,7 @@ The following is a set of guidelines for contributing to the website repository, - [**1.6 Dev setup (6): Build and serve the website locally**](#16-dev-setup-6-build-and-serve-the-website-locally) - [**1.6.a Starting Docker**](#16a-starting-docker) - [**1.6.b Stopping Docker**](#16b-stopping-docker) + - [**1.7 Dev setup (7): Install local codebase spell checker**](#17-dev-setup-7-install-local-codebase-spell-checker) - [**Part 2: How the Website team works with GitHub issues**](#part-2-how-the-website-team-works-with-github-issues) - [**2.1 Hack for LA Contributor expectations**](#21-hack-for-la-contributor-expectations) - [**2.2 How Hack for LA organizes issues**](#22-how-hack-for-la-organizes-issues) @@ -304,6 +305,20 @@ docker-compose up *** +### **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). + +For developers who do not use VS Code, use the corresponding npm package, cspell, and those instructions can be found [here](https://www.npmjs.com/package/cspell). + +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 VS Code extension or the cspell npm package on your system. + +[Back to Table of Contents](#table-of-contents) +*** + ## **Part 2: How the Website team works with GitHub issues** ### **2.1 Hack for LA Contributor expectations**