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 Code Spell Checker VS Code extension installation instructions #4101

Closed
7 tasks done
Tracked by #4264 ...
christinaor opened this issue Mar 3, 2023 · 6 comments · Fixed by #5751
Closed
7 tasks done
Tracked by #4264 ...

Add Code Spell Checker VS Code extension installation instructions #4101

christinaor opened this issue Mar 3, 2023 · 6 comments · Fixed by #5751
Assignees
Labels
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 time sensitive Needs to be worked on by a particular timeframe
Milestone

Comments

@christinaor
Copy link
Member

christinaor commented Mar 3, 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 misspellings so our reputation and the quality of our code is maintained. For this issue, we will add installation instructions for the VS Code extension, Code Spell Checker, 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 Code Spell Checker installation process with the following:
    - [**1.7 Dev setup (7): Install local codebase spell checker**](#17-dev-setup-7-install-local-codebase-spell-checker)
  • In the same file, add the following instructions for the installation process:
### **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). <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>
  • Changes to CONTRIBUTING.md cannot be tested locally, rather they must be tested after pushing the issue branch to your fork of the repository. Push your issue branch in the usual manner, but before creating the Pull Request, check your updates using this test URL. Also store the test URL for use in a later step:
https://github.com/[REPLACE WITH GITHUB HANDLE]/website/blob/[REPLACE WITH NAME OF ISSUE BRANCH]/CONTRIBUTING.md

(for example: https://github.com/bonniewolfe/website/blob/issue-branch-1234/CONTRIBUTING.md)

  • Ensure that the linkage from the first action item links correctly to the second action item's instructions.
  • Create a pull request in the usual manner, but after the "Why did you make the changes" section, add this line to help reviewers, replacing the text in brackets (and the brackets) with the test URL from the previous Action Item.
For Reviewers: Do not review changes locally, rather, review changes at [REPLACE WITH TEST URL]

Resources/Instructions

CONTRIBUTING.md
Getting started with writing and formatting on GitHub

Merge Team

  • After this issue is completed, change the instructions in the pre-work checklist from
Complete steps 1.1 - 1.6 in [Part 1: Setting up the development environment within Contributing.md]

to

Complete steps 1.1 - 1.7 in [Part 1: Setting up the development environment within Contributing.md]

Resources/Instructions

Related Issues

@christinaor christinaor added role: back end/devOps Tasks for back-end developers Complexity: Good second issue size: 0.25pt Can be done in 0.5 to 1.5 hours labels Mar 3, 2023
@github-actions github-actions bot added the Feature Missing This label means that the issue needs to be linked to a precise feature label. label Mar 3, 2023
@christinaor christinaor added Feature Missing This label means that the issue needs to be linked to a precise feature label. Feature: Onboarding/Contributing.md and removed Feature Missing This label means that the issue needs to be linked to a precise feature label. labels Mar 3, 2023
@christinaor christinaor changed the title DRAFT Add Code Spell Checker VS Code extension installation instructions Add Code Spell Checker VS Code extension installation instructions Mar 3, 2023
@t-will-gillis t-will-gillis added ready for dev lead Issues that tech leads or merge team members need to follow up on Ready for Prioritization and removed ready for dev lead Issues that tech leads or merge team members need to follow up on labels Mar 3, 2023
@ExperimentsInHonesty ExperimentsInHonesty added the time sensitive Needs to be worked on by a particular timeframe label Mar 5, 2023
@ExperimentsInHonesty ExperimentsInHonesty added this to the 05. Know HFLA milestone Mar 5, 2023
@ExperimentsInHonesty ExperimentsInHonesty added Feature: Feature Branch Requires Branching off a Feature Branch instead of gh-pages ready for dev lead Issues that tech leads or merge team members need to follow up on and removed Ready for Prioritization labels Mar 5, 2023
@ExperimentsInHonesty

This comment was marked as outdated.

@ExperimentsInHonesty ExperimentsInHonesty added Dependency An issue is blocking the completion or starting of another issue ready for dev lead Issues that tech leads or merge team members need to follow up on and removed ready for dev lead Issues that tech leads or merge team members need to follow up on labels Mar 21, 2023
@jdingeman

This comment was marked as resolved.

@jdingeman jdingeman added ready for product and removed ready for dev lead Issues that tech leads or merge team members need to follow up on labels Mar 30, 2023
@DevRishiJain DevRishiJain self-assigned this Jul 5, 2023
@github-actions

This comment was marked as outdated.

@DevRishiJain

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@github-actions
Copy link

Hi @jackyuan1, 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 :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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 time sensitive Needs to be worked on by a particular timeframe
Projects
Development

Successfully merging a pull request may close this issue.

9 participants