Skip to content
This repository has been archived by the owner on Oct 11, 2024. It is now read-only.

Spell Checker #826

Open
jalextowle opened this issue Jun 9, 2020 · 0 comments
Open

Spell Checker #826

jalextowle opened this issue Jun 9, 2020 · 0 comments
Labels
tech debt A code quality issue is not urgent but could cause problems down the line if not addressed

Comments

@jalextowle
Copy link
Contributor

Comments (and code names) frequently contain typos. These typos can be caught in code review, but this is an inconsistent and time consuming way to catch the issues.

The best way of solving this problem would be to enable spell checking for comments and identifiers using an automated tool (similar to a linter). If ignoring the feedback is sufficiently easy and easy to see, then this could even be a good addition to CI.
@jalextowle jalextowle added the tech debt A code quality issue is not urgent but could cause problems down the line if not addressed label Jun 9, 2020
@jalextowle jalextowle changed the title Add spell checker for comments Spell Checker Jun 9, 2020
@jalextowle jalextowle mentioned this issue Jul 11, 2020
Merged
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
tech debt A code quality issue is not urgent but could cause problems down the line if not addressed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jalextowle