GH Actions: add spellcheck + fix a few typos#151
Merged
Conversation
I was having a play with adding a spellchecker to the WPCS repo and when doing so, realized that some of the flagged texts - particularly in the WPCS-Core `ruleset.xml` file - are coming from this repo, so should probably be fixed here first.
So, this commit add a basic workflow with a spellcheck job.
Notes:
* The "Typos" tool is known for having a low false positive ratio and being aware of code contexts. However, this also means, it may at times miss some things.
When selecting it, I deemed the low false positive ratio more important.
* The language has been set to `en-US` as that's the language predominantly used for the WordPress documentation.
This does mean that various phrases using `en-GB` spelling will need to be fixed/updated.
* I've named the workflow file `qa.yml` with a workflow name of "Basic QA checks", even though there is only one check in the file at this time.
The idea behind this is that we may potentially want to add some markdown check tooling at some point and this way, that could go into the same workflow.
Ref: https://github.com/crate-ci/typos
jrfnl
added a commit
to WordPress/WordPress-Coding-Standards
that referenced
this pull request
Jun 26, 2025
Mostly US English vs UK English and as WP Core predominantly uses US English, I think we should standardize on that for this spellcheck as well. Note: where text was copied from the rules on https://developer.wordpress.org/coding-standards/ (typically to the `ruleset.xml` files), the text upstream has been updated via WordPress/wpcs-docs#151.
jrfnl
added a commit
to WordPress/WordPress-Coding-Standards
that referenced
this pull request
Jun 26, 2025
Mostly US English vs UK English and as WP Core predominantly uses US English, I think we should standardize on that for this spellcheck as well. Note: where text was copied from the rules on https://developer.wordpress.org/coding-standards/ (typically to the `ruleset.xml` files), the text upstream has been updated via WordPress/wpcs-docs#151.
jrfnl
added a commit
to WordPress/WordPress-Coding-Standards
that referenced
this pull request
Jun 26, 2025
Mostly US English vs UK English and as WP Core predominantly uses US English, I think we should standardize on that for this spellcheck as well. Note: where text was copied from the rules on https://developer.wordpress.org/coding-standards/ (typically to the `ruleset.xml` files), the text upstream has been updated via WordPress/wpcs-docs#151.
GaryJones
approved these changes
Jun 26, 2025
dingo-d
approved these changes
Jun 26, 2025
rodrigoprimo
approved these changes
Jun 26, 2025
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
4 participants
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.
GH Actions: add spellcheck
I was having a play with adding a spellchecker to the WPCS repo and when doing so, realized that some of the flagged texts - particularly in the WPCS-Core
ruleset.xmlfile - are coming from this repo, so should probably be fixed here first.So, this commit adds a basic workflow with a spellcheck job.
Notes:
When selecting it, I deemed the low false positive ratio more important.
en-USas that's the language predominantly used for the WordPress documentation.This does mean that various phrases using
en-GBspelling will need to be fixed/updated.qa.ymlwith a workflow name of "Basic QA checks", even though there is only one check in the file at this time.The idea behind this is that we may potentially want to add some markdown check tooling at some point and this way, that could go into the same workflow.
Ref: https://github.com/crate-ci/typos
Fix typos
Mostly UK spelling vs US spelling.