hackforla / hackforla/website

Develop GHA for spell checking PRs

Open
#5,334 2 comments 0 reactions 0 assignees View on GitHub
Complexity: Large Dependency Draft Feature: Administrative feature: spelling GHA New Project Board compatible HLC: M role: back end/devOps size: 2pt
Dominant language
JavaScript
Stars
363
Forks
872
Avg merge
2d 21h
Merged PRs (30d)
18

Description

### Dependency
- #5312

### Overview
We need a GHA to scan the files changed in Pull Requests using the Code Spell Checker CLI, in order to ensure that no misspellings are posted on the website.

### Action Items
- [ ] Become familiar with the resources describing the HfLA GHA archtecture[^1] and testing procedures[^2]
- [ ] Utilitize the Code Spell Checker CLI[^3] within a GitHub action, to be triggered when Pull Requests are opened (merging into `gh-pages`)
- [ ]

### Resources/Instructions
UI for failed spell check

![image](https://github.com/hackforla/website/assets/5314153/92d1495f-d490-4961-8af6-bd87f6d4ff07)


[Adding spell checking to my blog's build process](https://seankilleen.com/2021/01/adding-spell-checking-to-my-blogs-build-process-with-github-actions-and-cspell/)
[^1]:[Hack for LA's GitHub Actions](https://github.com/hackforla/website/wiki/Hack-for-LA's-GitHub-Actions)
[^2]:[HfLA GitHub Actions](https://github.com/hackforla/website/wiki/HfLA-GitHub-Actions)
[^3]:[Code Spell Checker npm package installation](https://www.npmjs.com/package/cspell)
[^4]:[How to set up cspell for spelling mistake free code](https://medium.com/@mitchwd/how-to-set-up-cspell-for-spelling-mistake-free-code-6148a2504d35)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.