Add ESlint VS Code installation instructions

bootcamp-brian commented 1 year ago

Dependency

[x] https://github.com/hackforla/website/issues/4101
[x] prioritization of Roll Out Plan for ESLint implementation (after spelling issues are resolved)

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. The extension can also be installed via the VS Code Marketplace website here. Feel free to reach out in the Hack for LA Slack channel if you have trouble installing the extension in VS Code.



- [ ] Ensure that the linkage from the first action item links correctly to the second action item's instructions.

### Resources/Instructions

- [ESLint VS Code extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
- [Installing VS Code extensions](https://code.visualstudio.com/learn/get-started/extensions)
- [CONTRIBUTING.md](https://github.com/hackforla/website/blob/gh-pages/CONTRIBUTING.md)

github-actions[bot] commented 1 year ago

Hi @bootcamp-brian.

Please don't forget to add the proper labels to this issue. Currently, the labels for the following are missing: Complexity, Role, Feature

NOTE: Please ignore the adding proper labels comment if you do not have 'write' access to this directory.

To add a label, take a look at Github's documentation here.

Also, don't forget to remove the "missing labels" afterwards. To remove a label, the process is similar to adding a label, but you select a currently added label to remove it.

After the proper labels are added, the merge team will review the issue and add a "Ready for Prioritization" label once it is ready for prioritization.

Additional Resources:

jdingeman commented 1 year ago

@ExperimentsInHonesty - hey Bonnie. This will likely run the same way as the VS Code Spell Checker with a roll out plan and everything. But our understanding is that we want the spell checker to be implemented first.

github-actions[bot] commented 1 year ago

Hi @DevRishiJain, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:- i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?) ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

Adastros commented 1 year ago

Dev moved this issue to the "In progress" column. Moving this issue back into the "Ice box" column. Pull request #4664 created for this issue closed.

ExperimentsInHonesty commented 5 months ago

Do we have a roll out plan yet for ES lint?

ExperimentsInHonesty commented 3 weeks ago

didnt get the answer to "Do we have a roll out plan yet for ES lint?" but we don't need to worry about it, until after the spelling issues are resolved.

hackforla / website