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.

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

Add ESlint VS Code installation instructions #4264

Open
2 of 5 tasks
Tracked by #2695
bootcamp-brian opened this issue Mar 23, 2023 · 6 comments
Open
2 of 5 tasks
Tracked by #2695

Add ESlint VS Code installation instructions #4264

bootcamp-brian opened this issue Mar 23, 2023 · 6 comments
Labels
Dependency An issue is blocking the completion or starting of another issue Feature: Onboarding/Contributing.md feature: spelling good first issue Good for newcomers role: back end/devOps Tasks for back-end developers size: 0.25pt Can be done in 0.5 to 1.5 hours

Comments

@bootcamp-brian
Copy link
Member

bootcamp-brian commented Mar 23, 2023

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

@bootcamp-brian bootcamp-brian added the ready for dev lead Issues that tech leads or merge team members need to follow up on label Mar 23, 2023
@github-actions github-actions bot added Feature Missing This label means that the issue needs to be linked to a precise feature label. role missing labels Mar 23, 2023
@github-actions

This comment was marked as outdated.

@jdingeman jdingeman added Complexity: Good second issue Dependency An issue is blocking the completion or starting of another issue role: back end/devOps Tasks for back-end developers Feature: Onboarding/Contributing.md size: 0.25pt Can be done in 0.5 to 1.5 hours ready for product and removed Feature Missing This label means that the issue needs to be linked to a precise feature label. role missing size: missing ready for dev lead Issues that tech leads or merge team members need to follow up on labels Mar 31, 2023
@jdingeman
Copy link
Member

@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.

@jdingeman jdingeman changed the title Implement local linter for developers to use in their local coding environment Add ESlint VS Code installation instructions Mar 31, 2023
@DevRishiJain DevRishiJain self-assigned this May 14, 2023
@github-actions

This comment was marked as off-topic.

@Adastros
Copy link
Member

Adastros commented May 16, 2023

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.

@roslynwythe roslynwythe added Dependency An issue is blocking the completion or starting of another issue and removed Dependency An issue is blocking the completion or starting of another issue labels Nov 27, 2023
@ExperimentsInHonesty
Copy link
Member

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

@ExperimentsInHonesty
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dependency An issue is blocking the completion or starting of another issue Feature: Onboarding/Contributing.md feature: spelling good first issue Good for newcomers role: back end/devOps Tasks for back-end developers size: 0.25pt Can be done in 0.5 to 1.5 hours
Projects
Development

Successfully merging a pull request may close this issue.

7 participants