-
-
Notifications
You must be signed in to change notification settings - Fork 847
Open
Labels
Complexity: MediumDependencyAn issue is blocking the completion or starting of another issueAn issue is blocking the completion or starting of another issueDraftIssue is still in the process of being createdIssue is still in the process of being createdFeature: InfrastructureFor changes on site technical architectureFor changes on site technical architecturefeature: spellingrole: dev leadsTasks for technical leadsTasks for technical leadssize: 1ptCan be done in 4-6 hoursCan be done in 4-6 hours
Milestone
Description
Dependencies
- Add Code Spell Checker VS Code extension installation instructions #4101
- add instructions for workstation spell checking using npm package #5652
- Epic: Create issues to add false positives to cspell.json #5312
- Epic: Create issues to add ignorePaths to cSpell configuration file #5450
- Epic: Create template, spreadsheet and list of issues for spellcheck audit #5248
- New wiki page "How to manage spell check warnings" ??
- Epic: Create template, spreadsheet and list of issues for spellcheck audit #5248
- Create issue template "Resolve Spell Check warning" #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.mdin 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
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
Complexity: MediumDependencyAn issue is blocking the completion or starting of another issueAn issue is blocking the completion or starting of another issueDraftIssue is still in the process of being createdIssue is still in the process of being createdFeature: InfrastructureFor changes on site technical architectureFor changes on site technical architecturefeature: spellingrole: dev leadsTasks for technical leadsTasks for technical leadssize: 1ptCan be done in 4-6 hoursCan be done in 4-6 hours
Type
Projects
Status
Ice box