-
-
Notifications
You must be signed in to change notification settings - Fork 692
Open
Description
Add a GitHub Actions workflow to run codespell on files changed in PRs,
catching spelling mistakes in documentation and code comments before they are merged.
Possible Labels
- new feature
- documentation
Category
- Enhancement
- Documentation
Update
Currently, there is no automated way to catch spelling mistakes in:
- Documentation files (
*.rst,*.md) - Python source code comments and docstrings (
*.py) - CI/build scripts and configuration files
PR #4720 fixed ~219 spelling errors manually using codespell. Automating this
check prevents regressions and catches new typos early.
Reference: #4720 (comment)
Scope (Phased Approach)
Phase 1 (This issue):
- Check only files changed in PRs (not entire codebase)
- Target:
.py,.rst,.mdfiles - Non-blocking (warning only) initially
- Report results in GitHub Job Summary
Phase 2 (Future):
- Make it blocking once false-positive rate is acceptable
- Extend to
.yml,.sh,.tomlfiles - Integrate with pre-commit hooks
How This Feature helps the organization
- Prevents spelling regressions from being merged
- Catches typos in documentation before they reach users/readthedocs
- Reduces manual review effort for spelling errors
- Improves overall documentation quality and professionalism
Implementation Details
Add a lightweight GitHub Actions workflow (.github/workflows/spell-check.yml) that:
- Triggers on PRs modifying
.py,.rst, or.mdfiles - Detects changed files using
git diff - Runs
codespellonly on those changed files - Reports results in the GitHub Job Summary (non-blocking/warning only)
Configuration:
setup.cfg[codespell]section with built-in dictionaries and skip patterns.codespell-ignore-words.txtcustom dictionary with project-specific terms
(ScanCode, nexB, PackageURL, SPDX, licensedcode, packagedcode, etc.)- Skips
tests/,samples/,thirdparty/,src/licensedcode/data/rules/
Example/Links if Any
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels