Skip to content

Update PR template with instructions regarding spell check messages #5202

@roslynwythe

Description

@roslynwythe

Dependencies

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

(#4786 (comment))

Metadata

Metadata

Assignees

No one assigned

    Labels

    Complexity: MediumDependencyAn issue is blocking the completion or starting of another issueDraftIssue is still in the process of being createdFeature: InfrastructureFor changes on site technical architecturefeature: spellingrole: dev leadsTasks for technical leadssize: 1ptCan be done in 4-6 hours

    Type

    No type

    Projects

    Status

    Ice box

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions