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.

Sign up for GitHub

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

added instructions for installation and use of the cspell npm packag… #5905

Merged
merged 5 commits into from
Nov 15, 2023
Merged

added instructions for installation and use of the cspell npm packag… #5905

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e05a790
added instructions for installation and use of the cspell npm packag…
robertnjenga Nov 14, 2023
28f88b4
modified table of contents
robertnjenga Nov 14, 2023
74083dd
modified table of contents in CONTRIBUTING.md
robertnjenga Nov 15, 2023
6abe93f
fixed typo and formatting
robertnjenga Nov 15, 2023
ec8263e
fixed typos
robertnjenga Nov 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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).

<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 VS Code extension or the cspell npm package on your system.</em></strong>

<sub>[Back to Table of Contents](#table-of-contents)</sub>
***

## **Part 2: How the Website team works with GitHub issues**

### **2.1 Hack for LA Contributor expectations**
Expand Down