Skip to content

Add ESlint VS Code installation instructions #4264

@bootcamp-brian

Description

@bootcamp-brian

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 coding errors so our reputation and the quality of our code is maintained. For this issue, we will add installation instructions for the VS Code extension, ESLint, 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 ESLint installation process with the following:
    - [**1.7.a Setup ESLint**](#17a-setup-eslint)
  • In the same file, add the following instructions for the installation process:
#### **1.7.a Setup ESLint**

You must use VS Code as your local text editor to install the VS Code extension for linting your codebase, ESLint.

The recommended installation method is to install ESLint 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=dbaeumer.vscode-eslint). <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>
  • Ensure that the linkage from the first action item links correctly to the second action item's instructions.

Resources/Instructions

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    Ice box

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions