-
Notifications
You must be signed in to change notification settings - Fork 102
ci: enforce typo checking #452
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This pull request introduces automated spell checking to the repository using the typos tool and fixes numerous spelling errors throughout the codebase. The automation ensures consistent spelling quality going forward while improving the professionalism of the project.
- Adds GitHub Actions workflow for automated spell checking on pushes, PRs, and daily schedules
- Introduces typos configuration with exclusions for Windows API identifiers
- Corrects spelling errors in documentation, code comments, and variable names across multiple files
Reviewed Changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
.github/workflows/typos.yml |
New GitHub Actions workflow for automated spell checking |
.typos.toml |
Configuration file for typos tool with Windows API exclusions |
CONTRIBUTING.md |
Documents the new spell checking process and local commands |
| Multiple source files | Fixes spelling errors in comments, documentation, and variable names |
Co-authored-by: Copilot <[email protected]> Signed-off-by: Melvin Wang <[email protected]>
Co-authored-by: Gurinder Singh <[email protected]> Signed-off-by: Melvin Wang <[email protected]>
This pull request introduces automated spell checking to the repository and fixes numerous typos and spelling errors across documentation, code comments, and identifiers. The most significant changes are the addition of a GitHub Actions workflow for spell checking, configuration for the spell checker, and corrections of various spelling mistakes throughout the codebase and documentation.
Spell checking automation:
.github/workflows/typos.ymlto runtyposfor spell checking on pushes, pull requests, merge groups, and on a daily schedule. This ensures that spelling errors are caught automatically in CI..typos.tomlconfiguration file to customize spell checking, including exclusions and allowed identifiers, particularly for Windows API compatibility.Documentation updates:
CONTRIBUTING.mdto document the new spell checking process, including instructions for running and auto-fixing typos locally, and notes on configuration.Spelling corrections in code and documentation:
These changes collectively improve the code quality, maintainability, and professionalism of the project by ensuring consistent and correct spelling throughout the repository.