Update PR template with instructions regarding spell check messages
- Dominant language
- JavaScript
- Stars
- 363
- Forks
- 872
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 18
Description
### Dependencies
- [x] #4101
- [x] #5652
- [ ] https://github.com/hackforla/website/issues/5312
- [x] https://github.com/hackforla/website/issues/5450
- [ ] https://github.com/hackforla/website/issues/5248
- [ ] New wiki page "How to manage spell check warnings" ??
- [ ] #5248
- [ ] #6446
### Overview
We need to direct developers how to manage spell check messages on changed files locally, and also those that may appear in Pull Request checks. Developers will be instructed to correct spelling errors where appropriate, modifying cspell.json as appropriate to suppress false positives, and to note changes in a new section of the PR template "What changes did you make in response to code linter recommendations?"
### Action Items
- [ ] Open the file `.github/pull_request_template.md` in your IDE
- [ ] Following the section "Why did you make the changes (we will use this info to test)?" add this section:
```
Note to developers:
- [ ] If spell check warnings ("unknown word") are displayed either locally (in VS Code Spell Check Extension) or in GitHub PR checks, follow instructions in "How to manage spell check warnings"
- [ ] Alternatively, create a new issue based on the template "Resolve Spell Check warning"
- [ ] If any file changes are made in response to linter warnings, document those in the pull request, in the section "What changes did you make?
```
### Resources/Instructions
(https://github.com/hackforla/website/issues/4786#issuecomment-1670584024)
Contributor guide
Assessment
This issue has not been assessed yet.