chore: add typos spell checker #58
Merged
Conversation
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
- Add typos.toml configuration file - Add typos CI job to workflow - Add typos and typos-lsp to flake.nix devShell - Enable typos in treefmt - Add just typos command
- optimised → optimized - Initialise → Initialize - behavioural → behavioral - behaviour → behavior - Analyse → Analyze
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds the typos spell checker to the project's development workflow and CI pipeline, standardizing on US English spelling throughout the codebase.
Key changes:
- Added
typos.tomlconfiguration file with US English locale and appropriate ignore patterns - Corrected UK to US English spelling in code comments and documentation (optimised→optimized, initialise→initialize, analyse→analyze, behavioural→behavioral)
- Integrated typos into CI workflow, Nix development shell, treefmt, and justfile commands
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| typos.toml | Adds typos configuration with US English locale, custom ignore patterns for inline spell-check directives, and exclusions for .venv, uv.lock, and CHANGELOG.md |
| stackone_ai/constants.py | Corrects spelling from "optimised" to "optimized" in code comment |
| README.md | Corrects UK to US English spelling in documentation (initialise→initialize, behavioural→behavioral, analyse→analyze) |
| justfile | Adds typos and typos-fix commands for running spell checker and auto-fixing typos |
| flake.nix | Enables typos in treefmt configuration and adds typos and typos-lsp to development shell packages |
| .github/workflows/ci.yml | Adds typos CI job that runs spell checker using Nix development environment |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
- Integrate main branch updates (rules structure, workflow updates) - Resolve justfile conflict by combining typos and build commands
jrebocho
approved these changes
Dec 18, 2025
Member
Author
|
thanks @jrebocho i got spell error lol omg |
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.
Summary
typos.toml)typosandtypos-lspto flake.nix devShelljust typosandjust typos-fixcommandsTest plan
just typoslocally to verify spell checking worksSummary by cubic
Add a typos spell checker with en-us locale and enforce it in CI to catch spelling issues early. Standardizes US English across docs and comments.
New Features
Bug Fixes
Written for commit 8fc455c. Summary will update automatically on new commits.