Create wiki page "How to manage spell check warnings"

roslynwythe commented 3 months ago

Overview

We require a wiki page to guide developers how to manage and resolve spell check warnings

Action Items

[x] We are currently in the process of moving the old wiki to the new website-wiki repo, so we will not be making any changes or additions to the old wiki at this time. Thus, we will be adding wiki content through a different process now. Read How to Contribute to the Wiki
[x] Create a wiki page "How to manage spell check warnings" that covers the following topics:
- [x] Introduction to spell checking
- [x] Managing misspelled words
- [x] Managing false positives
- [x] Excluding a section of code from spell checking
- [x] Excluding a file or folder from spell checking

Resources/Instructions

This issue resulted from #4349

Resources/Instructions

Introduction to JSON Code Spell Checker

[^1]: Installing Code Spell Checker from the VS Code text editor [^2]:Code Spell Checker - VS Marketplace

github-actions[bot] commented 3 months ago

Hi @roslynwythe.

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

Complexity, Role, Feature, Size

NOTE: Please ignore this 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:

github-actions[bot] commented 3 months ago

Hi @roslynwythe, HfLA appreciates your interest in this issue, but please note that it is in the New Issue Approval column of the Project Board because it has not been finalized, approved or prioritized, and so it is not ready for assignment. For this reason, you have been unassigned from this issue. Please remember to assign issues only from the Prioritized Backlog column. The one exception to this rule is if you are writing an issue and the Draft label is applied.

roslynwythe commented 3 months ago

Draft wiki page "How to manage spell check warnings"

Hack for LA developers are instructed to use Spell Checker for VS Code or the cspell npm package as described in CONTRIBUTING.md Section 1.7. Both versions are intended for working with code files and both utilitze the configuration file cspell.json in the root of the website folder. In the future, cspell-based spell checking will also be incorporated into the GitHub checks which take place in pull requests.

Developers should note spell check warnings (i.e, "unknown word") and resolve them as described below, prior to creating a pull request. File changes made to resolve spell check warnings will be considered within the scope of the linked issue, but should be noted in the Pull Request.

Resolving spell check warnings

- [ ] If there was a genuine misspelling, make the spelling correction(s) 
- [ ] If the "unknown word" should be considerd a "word" (ie "markdownify"), edit the file `cspell.json` and add the term to the "words" array
- [ ] If the "unknown word" should be ignored by the spell checker (such as the name of an individual) edit the file 'cspell.json` and add the term to the "ignoreWords" array
- [ ] It is possible to disable / enable the spell checker for a section of code by adding comments.   Details depend on the file type and can be found in [Code Spell Checker documentation](https://streetsidesoftware.com/vscode-spell-checker/)
- [ ] If the entire file should be excluded from spell checking, because it contains no public-facing text, edit the file `cspell.json` and add the file path to the `ignorePaths` array

github-actions[bot] commented 3 months ago

Hi @roslynwythe, HfLA appreciates your interest in this issue, but please note that it is in the New Issue Approval column of the Project Board because it has not been finalized, approved or prioritized, and so it is not ready for assignment. For this reason, you have been unassigned from this issue. Please remember to assign issues only from the Prioritized Backlog column. The one exception to this rule is if you are writing an issue and the Draft label is applied.

github-actions[bot] commented 3 months ago

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

roslynwythe commented 3 months ago

@ExperimentsInHonesty In the wiki page I would have liked to reference the issue template for resolving spell check errors, but that link doesn't exist yet so I omitted it.

How to Contribute to the Wiki has been updated with a link to the draft wiki page so if the draft looks good please close this issue then release the dependency on #6446 - which will be ready for prioritization

ExperimentsInHonesty commented 3 months ago

@roslynwythe I think the checkboxes on the wiki need to have more specific instructions, given that they might end up being needed by good first issue people. See my draft below

Draft wiki page "How to manage spell check warnings"

Hack for LA developers are instructed to use Spell Checker for VS Code or the cspell npm package as described in CONTRIBUTING.md Section 1.7. Both versions are intended for working with code files, and both utilize the configuration file cspell.json in the root of the website folder. In the future, cspell-based spell checking will also be incorporated into the GitHub checks which take place in pull requests.

Developers should note spell check warnings (i.e, "unknown word") and resolve them, as described below, prior to creating a pull request. Add the appropriate one or more of the following to your issue in a comment, and do the action items as instructed:

Resolving spell check warnings

Genuine Misspelling

### Additonal Action Items based on spelling warning - correct spelling error
- [ ] make the spelling correction(s)
- [ ] note in pull request what what the original spelling was and what you are changing it to

"unknown word" should be considered a "word" (ie "markdownify")

### Additonal Action Items based on spelling warning - unknown word
- [ ] edit the file `cspell.json` file located in the root directory, and add the term to the "words" array

"unknown word" should be ignored by the spell checker (such as the name of an individual)

### Additonal Action Items based on spelling warning - ignore word
- [ ] edit the file 'cspell.json` and add the term to the "ignoreWords" array

A section of code has a number of words that we want the spell checker to ignore

### Additonal Action Items based on spelling warning - Disable the spell checker for a section of code
- [ ] Disable / enable the spell checker for a section of code by adding comments.   Details depend on the file type and can be found in [Code Spell Checker documentation](https://streetsidesoftware.com/vscode-spell-checker/)

File's content is not public facing

### Additonal Action Items based on spelling warning - file content not public facing
- [ ] edit the file `cspell.json` and add the file path to the `ignorePaths` array

github-actions[bot] commented 3 months ago

@roslynwythe

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

Progress: "What is the current status of your project? What have you completed and what is left to do?"
Blockers: "Difficulties or errors encountered."
Availability: "How much time will you have this week to work on this issue?"
ETA: "When do you expect this issue to be completed?"
Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the Questions/In Review column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.

_{You are receiving this comment because your last comment was before Tuesday, April 2, 2024 at 12:05 AM PST.}

roslynwythe commented 3 months ago

@ExperimentsInHonesty Thank you for the draft, it looks really nice. I replaced "NOT SURE WHAT SCENARIO THEY SHOULD USE THIS IN" with "A section of code has a number of words that we want the spell checker to ignore". Basically you can create a HTML or JS comment with a keyword, in order to exclude a section of code from spell checking. I have not yet used this method, but I am planning to try it out in order to exclude the name of individuals in the wins json file.

You suggest having the developer make notes regarding spell check corrections in a comment in the issue. That is fine but another alternative would be to create a section in the Pull Request template, in which developers could document changes they made in response to spell check as well as other linter type warnings.

If you don't want any more changes please close this one.

ExperimentsInHonesty commented 3 months ago

@roslynwythe I agree that we should have them note on the PR any spelling changes. I also suggest that we tell them what to put here, that way the PR could just have an area for it. The area could have this content

### Spelling changes
- [ ] no spelling changes
- [ ] spelling changes
<details><summary>Instructions for what to put in this section if there are spelling changes</summary>
<p>
https://github.com/hackforla/website/issues/6519#issuecomment-2041555977
</p>
</details>

I have edited the draft below. If you think the draft is good to go, we should also update the PR template with the above

ExperimentsInHonesty commented 3 months ago

Draft wiki page "How to manage spell check warnings"

Hack for LA developers are instructed to use Spell Checker for VS Code or the cspell npm package as described in CONTRIBUTING.md Section 1.7. Both versions are intended for working with code files, and both utilize the configuration file cspell.json in the root of the website folder. In the future, cspell-based spell checking will also be incorporated into the GitHub checks which take place in pull requests.

Developers should note spell check warnings (i.e, "unknown word") and resolve them, as described below, prior to creating a pull request. Add the appropriate one or more of the following to your issue in a comment, and do the action items as instructed:

Resolving spell check warnings

Genuine Misspelling

### Additional Action Items based on spelling warning - correct spelling error
- [ ] make the spelling correction(s)
- [ ] note in pull request with what the original spelling was and what you are changing it to by pasting this template and filling it out, under the Spelling changes section of the PR comment

Original Spelling: Revision:

"unknown word" should be considered a "word" (ie "markdownify")

### Additional Action Items based on spelling warning - unknown word
- [ ] edit the file `cspell.json` file located in the root directory, and add the term to the "words" array
- [ ] note in pull request with what the word is by pasting this template and filling it out, under the Spelling changes section of the PR comment

Unknown word caught by spell check should be considered a word and has been added to cspell.json:

"unknown word" should be ignored by the spell checker (such as the name of an individual)

### Additional Action Items based on spelling warning - ignore word
- [ ] edit the file 'cspell.json` and add the term to the "ignoreWords" array
- [ ] note in pull request with what the word is by pasting this template and filling it out, under the Spelling changes section of the PR comment

Unknown word caught by spell check should be ignored and has been added to cspell.json:

A section of code has a number of words that we want the spell checker to ignore

### Additional Action Items based on spelling warning - Disable the spell checker for a section of code
- [ ] Disable / enable the spell checker for a section of code by adding comments.   Details depend on the file type and can be found in [Code Spell Checker documentation](https://streetsidesoftware.com/vscode-spell-checker/)
- [ ] note in pull request with what the word is by pasting this template and filling it out, under the Spelling changes section of the PR comment

A section of code should be ignored, and I have disabled the spell checker for a section of code starting on lines:

File's content is not public facing

### Additional Action Items based on spelling warning - file content not public facing
- [ ] edit the file `cspell.json` and add the file path to the `ignorePaths` array
- [ ] note in pull request with what the word is by pasting this template and filling it out, under the Spelling changes section of the PR comment

This file has been added to the ignorePaths array, since there are spelling errors flagged by the spell check, but changes do not need to be made because the file is not public facing:

github-actions[bot] commented 3 months ago

@roslynwythe

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

Progress: "What is the current status of your project? What have you completed and what is left to do?"
Blockers: "Difficulties or errors encountered."
Availability: "How much time will you have this week to work on this issue?"
ETA: "When do you expect this issue to be completed?"
Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the Questions/In Review column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.

_{You are receiving this comment because your last comment was before Tuesday, April 16, 2024 at 12:06 AM PST.}

github-actions[bot] commented 2 months ago

@roslynwythe

Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.

Progress: "What is the current status of your project? What have you completed and what is left to do?"
Blockers: "Difficulties or errors encountered."
Availability: "How much time will you have this week to work on this issue?"
ETA: "When do you expect this issue to be completed?"
Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the Questions/In Review column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.

_{You are receiving this comment because your last comment was before Tuesday, April 23, 2024 at 12:06 AM PST.}

github-actions[bot] commented 2 months ago

@roslynwythe

Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.

Progress: "What is the current status of your project? What have you completed and what is left to do?"
Blockers: "Difficulties or errors encountered."
Availability: "How much time will you have this week to work on this issue?"
ETA: "When do you expect this issue to be completed?"
Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the Questions/In Review column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.

_{You are receiving this comment because your last comment was before Tuesday, April 30, 2024 at 12:06 AM PST.}

github-actions[bot] commented 2 months ago

@roslynwythe

Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.

Progress: "What is the current status of your project? What have you completed and what is left to do?"
Blockers: "Difficulties or errors encountered."
Availability: "How much time will you have this week to work on this issue?"
ETA: "When do you expect this issue to be completed?"
Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the Questions/In Review column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.

_{You are receiving this comment because your last comment was before Tuesday, May 7, 2024 at 12:06 AM PST.}

LRenDO commented 2 months ago

Hi @roslynwythe and @ExperimentsInHonesty!

I was going through the two weeks inactive issues and it looks like the work on this issue may be complete. However, the link for the draft on the How to contribute to the wiki page links to the first draft comment and it seems like it might need to link to the last draft comment. I am flagging it in case the link needs to be changed and/or the issue can be closed.

github-actions[bot] commented 2 months ago

@roslynwythe

Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.

Progress: "What is the current status of your project? What have you completed and what is left to do?"
Blockers: "Difficulties or errors encountered."
Availability: "How much time will you have this week to work on this issue?"
ETA: "When do you expect this issue to be completed?"
Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the Questions/In Review column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.

_{You are receiving this comment because your last comment was before Tuesday, May 14, 2024 at 12:06 AM PST.}

github-actions[bot] commented 1 month ago

@roslynwythe

Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.

Progress: "What is the current status of your project? What have you completed and what is left to do?"
Blockers: "Difficulties or errors encountered."
Availability: "How much time will you have this week to work on this issue?"
ETA: "When do you expect this issue to be completed?"
Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the Questions/In Review column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.

_{You are receiving this comment because your last comment was before Tuesday, May 21, 2024 at 12:06 AM PST.}

github-actions[bot] commented 1 month ago

@roslynwythe

Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.

Progress: "What is the current status of your project? What have you completed and what is left to do?"
Blockers: "Difficulties or errors encountered."
Availability: "How much time will you have this week to work on this issue?"
ETA: "When do you expect this issue to be completed?"
Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the Questions/In Review column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.

_{You are receiving this comment because your last comment was before Tuesday, May 28, 2024 at 12:06 AM PST.}

github-actions[bot] commented 1 month ago

@roslynwythe

Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.

Progress: "What is the current status of your project? What have you completed and what is left to do?"
Blockers: "Difficulties or errors encountered."
Availability: "How much time will you have this week to work on this issue?"
ETA: "When do you expect this issue to be completed?"
Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the Questions/In Review column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.

_{You are receiving this comment because your last comment was before Tuesday, June 4, 2024 at 12:06 AM PST.}

github-actions[bot] commented 1 month ago

@roslynwythe

Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.

Progress: "What is the current status of your project? What have you completed and what is left to do?"
Blockers: "Difficulties or errors encountered."
Availability: "How much time will you have this week to work on this issue?"
ETA: "When do you expect this issue to be completed?"
Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the Questions/In Review column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.

_{You are receiving this comment because your last comment was before Tuesday, June 11, 2024 at 12:06 AM PST.}

github-actions[bot] commented 3 weeks ago

@roslynwythe

Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.

Progress: "What is the current status of your project? What have you completed and what is left to do?"
Blockers: "Difficulties or errors encountered."
Availability: "How much time will you have this week to work on this issue?"
ETA: "When do you expect this issue to be completed?"
Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the Questions/In Review column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.

_{You are receiving this comment because your last comment was before Tuesday, June 18, 2024 at 12:06 AM PST.}

github-actions[bot] commented 3 weeks ago

@roslynwythe

Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.

Progress: "What is the current status of your project? What have you completed and what is left to do?"
Blockers: "Difficulties or errors encountered."
Availability: "How much time will you have this week to work on this issue?"
ETA: "When do you expect this issue to be completed?"
Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the Questions/In Review column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.

_{You are receiving this comment because your last comment was before Wednesday, June 19, 2024 at 1:48 PM PST.}

hackforla / website