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

Epic: Create template, spreadsheet and list of issues for spellcheck audit #5248

Open
Tracked by #4349 ...
roslynwythe opened this issue Aug 17, 2023 · 61 comments
Open
Tracked by #4349 ...
Assignees
Labels
Complexity: See issue making label See the Issue Making label to understand the issue writing difficulty level epic feature: spelling Issue Making: Level 2 Make issue(s) from an ER or Epic role: back end/devOps Tasks for back-end developers size: 1pt Can be done in 4-6 hours To Update ! No update has been provided

Comments

@roslynwythe
Copy link
Member

roslynwythe commented Aug 17, 2023

Dependency

Note: some spellcheck issues are not listed above - see the Issue Making Level 1 issues below

Dependencies/ Issue Making Level 1 issues

Overview

We need to create issues to audit all appropriate codebase files for Code Spell Checker results. The HfLA spelling audit spreadsheet1 will be used to track spell check audit issues, record false positives and misspellings, and track resulting issues for resolving errors.

Action Items

Resources/Instructions

Footnotes

  1. HfLA spelling audit spreadsheet 2

@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 Aug 17, 2023
@github-actions

This comment has been minimized.

@roslynwythe roslynwythe added Draft Issue is still in the process of being created Complexity: Medium role: back end/devOps Tasks for back-end developers size: 1pt Can be done in 4-6 hours Feature: Administrative Administrative chores etc. and removed role missing size: missing labels Aug 17, 2023
@Gourav2609

This comment was marked as outdated.

@roslynwythe roslynwythe added Complexity: See issue making label See the Issue Making label to understand the issue writing difficulty level Issue Making: Level 2 Make issue(s) from an ER or Epic and removed Complexity: Medium Feature Missing This label means that the issue needs to be linked to a precise feature label. labels Aug 20, 2023
@roslynwythe

This comment was marked as outdated.

@roslynwythe
Copy link
Member Author

roslynwythe commented Aug 20, 2023

Draft Audit Issue Template

Title: Run VSCode Spell Checker on [INSERT FILE PATH]

### Overview
We need to audit HfLA codebase files for spelling errors using the VSCode Code Spell Checker extension in order to ensure site quality.  Results will be categorized as misspellings, false positives in the HfLA spelling audit spreadsheet[^1] and will be resolved in later issues.  

### Action Items
- [ ] You must use VS Code as your local text editor and install the `Code Spell Checker` VS Code extension[^2]  
- [ ] Do not change any configuration settings or make any spell corrections
- [ ] Open the file '[INSERT FILE PATH]'and note any Code Spell Checker errors
- [ ] Locate the file in column A ("File") of the "Page Audit" sheet.  In the column labelled "Result Summary", select the appropriate option:  `No errors` or `At least one error`.  
- [ ] If at least one error was reported, copy/paste each cSpell message into a separate row in the `Results` sheet
- [ ] In each new row, select the appropriate value: `misspelling` or `false positive` from the "Result type" column.  A false positive is a term that is not a misspelling, but it is not recognized by the spell checker because it is a technical term, abbreviation, acronym, URL or proper noun (name of a person, place or organization).  
- [ ] Move this issue to the Questions/In Review column and apply the label 'ready for dev lead`

### Merge Team
- [ ] After this issue is closed, release the dependency on this issue in #5248
- [ ] After the last dependency has been released, close that issue. 

### Resources/Instructions
- This issue is part of #5248
[^1]: [HfLA spelling audit spreadsheet - Results](https://docs.google.com/spreadsheets/d/1c2C9zUF_LsLGrnJN_LAlPV4UObz-nYffJyOiB_M6oI0/edit#gid=69989048)
[^2]: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). 

@roslynwythe roslynwythe changed the title List files to be included in spell check in spreadsheet, exclude others in config files Epic: Create Issues to audit files for Code Spell Checker results Aug 20, 2023
@roslynwythe roslynwythe changed the title Epic: Create Issues to audit files for Code Spell Checker results Epic: Create Issues to audit/spell check files Aug 20, 2023
@roslynwythe roslynwythe changed the title Epic: Create Issues to audit/spell check files Epic: Create Issues to audit/spellcheck files Aug 20, 2023
@roslynwythe roslynwythe self-assigned this Aug 24, 2023
@github-actions

This comment has been minimized.

@roslynwythe roslynwythe added ready for product and removed Draft Issue is still in the process of being created labels Aug 24, 2023
@ExperimentsInHonesty ExperimentsInHonesty moved this from New Issue Approval to In progress (actively working) in P: HfLA Website: Project Board Oct 15, 2024
@HackforLABot

This comment has been minimized.

@HackforLABot
Copy link
Contributor

@roslynwythe, @essencegoff

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.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. 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, October 22, 2024 at 12:04 AM PST.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: See issue making label See the Issue Making label to understand the issue writing difficulty level epic feature: spelling Issue Making: Level 2 Make issue(s) from an ER or Epic role: back end/devOps Tasks for back-end developers size: 1pt Can be done in 4-6 hours To Update ! No update has been provided
Projects
Status: In progress (actively working)
Development

No branches or pull requests

7 participants