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 instructions for workstation spell checking using npm package #5652

Closed
6 of 7 tasks
Tracked by #4349 ...
roslynwythe opened this issue Oct 3, 2023 · 4 comments · Fixed by #5905
Closed
6 of 7 tasks
Tracked by #4349 ...

add instructions for workstation spell checking using npm package #5652

roslynwythe opened this issue Oct 3, 2023 · 4 comments · Fixed by #5905
Assignees
Labels

Comments

@roslynwythe
Copy link
Member

roslynwythe commented Oct 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. The recommended method of local spell checking is to use the VSCode Code Spell Checker extension, but for developers who do not use VSCode, we need to provide guidance for use of the corresponding npm package, cspell

Action Items

  • In CONTRIBUTING.md, section 1.7 add instructions for local codebase spell checking for users who do not use VSCode.
  • Provide instructions for installation and use of the cspell npm package
  • 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
cspell npm package

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

@roslynwythe roslynwythe added Feature Missing This label means that the issue needs to be linked to a precise feature label. role missing size: missing labels Oct 3, 2023
@github-actions

This comment was marked as outdated.

@roslynwythe roslynwythe added Complexity: Medium Feature: Onboarding/Contributing.md role: front end Tasks for front end developers role: back end/devOps Tasks for back-end developers size: 1pt Can be done in 4-6 hours Dependency An issue is blocking the completion or starting of another issue and removed Feature Missing This label means that the issue needs to be linked to a precise feature label. role missing size: missing labels Oct 3, 2023
@roslynwythe roslynwythe added Ready for Prioritization and removed Dependency An issue is blocking the completion or starting of another issue labels Oct 23, 2023
@ExperimentsInHonesty ExperimentsInHonesty added this to the 08. Team workflow milestone Nov 6, 2023
@GRK1998 GRK1998 self-assigned this Nov 12, 2023
Copy link

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

@GRK1998 GRK1998 removed their assignment Nov 12, 2023
@robertnjenga robertnjenga self-assigned this Nov 14, 2023
Copy link

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

@robertnjenga
Copy link
Member

Availability: Mon-Fri 10a-2p
ETA: 11/14/2023

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Development

Successfully merging a pull request may close this issue.

4 participants