Fix spelling and grammar issues + add CI detection - #501
Merged
Conversation
rwmcguir
force-pushed
the
gh-issue-424
branch
4 times, most recently
from
July 30, 2026 23:54
9199706 to
b4587b5
Compare
+ Also remove node 20 deprecation for checkout@v4 GH actions Signed-off-by: Russell McGuire <russell.w.mcguire@intel.com>
Signed-off-by: Russell McGuire <russell.w.mcguire@intel.com>
There was a problem hiding this comment.
Pull request overview
This PR primarily standardizes spelling/grammar across loader, validation layer, headers, docs, and templates, and introduces a CI spell-checking signal (codespell) that can surface findings inline and via an automated PR comment. It also updates several GitHub Actions workflows to use actions/checkout@v5.
Changes:
- Fixes numerous spelling/grammar issues across C/C++ sources/headers, Python bindings, docs, templates, and changelog entries.
- Adds a Codespell CI workflow and a companion
workflow_runworkflow to post/update a PR comment with the report. - Updates multiple existing workflows to use
actions/checkout@v5and improves token handling inupdate-spec.yml.
Reviewed changes
Copilot reviewed 49 out of 49 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| test/CMakeLists.txt | Fixes spelling in test comment. |
| source/loader/zes_ldrddi.h | Fixes typos in API comments. |
| source/loader/zes_ldrddi.cpp | Fixes typos in API comments. |
| source/loader/zes_ldrddi_driver_ddi.cpp | Fixes typos in API comments. |
| source/loader/ze_loader.cpp | Fixes spelling in loader comment. |
| source/loader/ze_loader_internal.h | Fixes spelling in enum documentation. |
| source/loader/ze_ldrddi.cpp | Fixes spelling in comments. |
| source/lib/zet_libapi.cpp | Fixes typo in API documentation. |
| source/lib/zes_libapi.cpp | Fixes typos in API comments. |
| source/lib/ze_libapi.cpp | Fixes typos in API documentation. |
| source/layers/validation/zes_valddi.cpp | Fixes typos in validation-layer comments. |
| source/layers/validation/README.md | Fixes typo in README heading. |
| source/layers/validation/handle_lifetime_tracking/zes_handle_lifetime.cpp | Fixes typos in prologue comments. |
| source/layers/validation/CONTRIBUTING.md | Fixes typo in contributor doc. |
| source/layers/validation/checkers/parameter_validation/zes_parameter_validation.cpp | Fixes typos in parameter-validation prologue comments. |
| source/layers/validation/checkers/events_checker/zel_events_checker.cpp | Fixes typos in checker comments/parameter docs. |
| source/layers/validation/checkers/basic_leak/zel_basic_leak_checker.cpp | Fixes typo in comment. |
| source/drivers/null/zes_nullddi.cpp | Fixes typos in null driver DDI comments. |
| scripts/templates/ze_loader_internal.h.mako | Keeps template comments aligned with header spelling fixes. |
| scripts/templates/validation/handle_lifetime.cpp.mako | Fixes typo in generator comment. |
| scripts/templates/ldrddi.cpp.mako | Fixes typos in generator comments. |
| scripts/templates/helper.py | Fixes typos in helper docstrings/comments. |
| README.md | Fixes spelling in project README. |
| include/zet.py | Fixes spelling in Python binding comments. |
| include/zet_api.h | Fixes typos in public header docs. |
| include/zes.py | Fixes multiple typos in Python binding comments/docs. |
| include/zes_api.h | Fixes typos in public header docs. |
| include/ze.py | Fixes typos in Python binding comments/docs. |
| include/ze_api.h | Fixes typos in public header docs. |
| include/layers/zel_tracing_api.h | Fixes typo in comment. |
| doc/loader_api.md | Fixes typos in loader API documentation. |
| CHANGELOG.md | Fixes spelling in changelog entries. |
| bindings/sysman/python/source/pyzes.py | Fixes typo in Python binding source comment. |
| .github/workflows/update-spec.yml | Updates checkout action version and token fallback handling. |
| .github/workflows/scorecard.yml | Updates checkout action version. |
| .github/workflows/codespell.yml | Adds codespell PR workflow producing annotations + artifact report. |
| .github/workflows/codespell-comment.yml | Adds workflow-run job to post/update PR comment from codespell artifact. |
| .github/workflows/check-abi.yml | Updates checkout action versions. |
| .github/workflows/build-quick.yml | Updates checkout action version. |
| .github/workflows/build-quick-static.yml | Updates checkout action version. |
| .github/workflows/build-quick-static-n-1.yml | Updates checkout action versions. |
| .github/workflows/build-multi.yml | Updates checkout action versions. |
| .github/workflows/build-multi-static.yml | Updates checkout action versions. |
| .github/workflows/build-msi-package.yml | Updates checkout action version. |
| .github/workflows/build-clang.yml | Updates checkout action version. |
| .github/workflows/bindings-sysman-python-unit-tests-coverage.yml | Updates checkout action version. |
| .github/workflows/bindings-sysman-python-security-scan.yml | Updates checkout action version. |
| .github/workflows/bindings-sysman-python-checks.yml | Updates checkout action version. |
| .codespellrc | Adds codespell configuration (skip list + ignore words). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Russell McGuire <russell.w.mcguire@intel.com>
rwmcguir
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.