Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add GitHub Action to check spelling #1226

Merged
merged 10 commits into from
Jan 25, 2022
Merged

Conversation

aaronraimist
Copy link

@aaronraimist aaronraimist commented Jan 15, 2022

Works the same way as matrix-org/matrix-spec-proposals#3591

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://pr1226--matrix-org-previews.netlify.app

.github/_typos.toml Outdated Show resolved Hide resolved
@afranke afranke merged commit 41654d4 into matrix-org:master Jan 25, 2022
@aaronraimist aaronraimist deleted the typos branch January 26, 2022 01:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants