Add GitHub Action to check spelling #3591
Merged
Conversation
This file contains 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.
Fixes #3586
This uses https://github.com/crate-ci/typos so it will only find known misspellings in their dictionary. It won't know about or correct Matrix specific terminology but I think this should find most of the misspellings.
When it finds a typo it looks like this https://github.com/aaronraimist/matrix-doc/runs/4621564484?check_suite_focus=true
When there is a false positive, like a room ID, it can be added to the exclude list in https://github.com/matrix-org/matrix-doc/blob/1f41c6db6c943f19643dbeba31fb045d81da9728/.github/_typos.toml
Preview: https://pr3591--matrix-org-previews.netlify.app