From e05a7902aa331288e469284bfce14da5f831bc2c Mon Sep 17 00:00:00 2001 From: robert_codes Date: Tue, 14 Nov 2023 14:07:26 -0800 Subject: [PATCH 1/5] added instructions for installation and use of the cspell npm package to CONTRIBUTING.md --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 941b3b8372..14a737ee3a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -304,6 +304,19 @@ 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 VSCode, 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 docker 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** From 28f88b436169413719a36d9423e66ae642ef5025 Mon Sep 17 00:00:00 2001 From: robert_codes Date: Tue, 14 Nov 2023 15:20:48 -0800 Subject: [PATCH 2/5] modified table of contents --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 14a737ee3a..bf0ce50bf9 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-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) From 74083ddb507930c86c4e70863c86fa87598975ec Mon Sep 17 00:00:00 2001 From: robert_codes Date: Tue, 14 Nov 2023 16:18:34 -0800 Subject: [PATCH 3/5] modified table of contents in CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bf0ce50bf9..326ac684bd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,7 +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-Install-local-codebase-spell-checker) + - [**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) From 6abe93f575b35097e1957a74f4e5b95936002249 Mon Sep 17 00:00:00 2001 From: robert_codes Date: Tue, 14 Nov 2023 17:58:36 -0800 Subject: [PATCH 4/5] fixed typo and formatting --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 326ac684bd..cff62638bb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -313,7 +313,8 @@ The recommended installation method is to install Code Spell Checker directly fr 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 VSCode, 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 docker on your system + +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 VSCode extension or the cspell npm package on your system. [Back to Table of Contents](#table-of-contents) *** From ec8263e3048dbfece4b90bcf8b1694d7ef53bdc2 Mon Sep 17 00:00:00 2001 From: robert_codes Date: Tue, 14 Nov 2023 19:18:35 -0800 Subject: [PATCH 5/5] fixed typos --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cff62638bb..95fbccef72 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -312,9 +312,9 @@ You must use VS Code as your local text editor to install the VS Code extension 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 VSCode, use the corresponding npm package, cspell, and those instructions can be found [here](https://www.npmjs.com/package/cspell). +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 VSCode extension or the cspell npm package on your system. +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) ***