CI: Add typo check workflow #953
Open
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
Signed-off-by: atilsensalduz <[email protected]>
Signed-off-by: atilsensalduz <[email protected]>
Signed-off-by: atilsensalduz <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This PR adds a typo check to CI using the typos GitHub Action. I also created a .typos.toml config file so we can ignore certain words that are either project specific, technical terms, or intentionally spelled that way. Without this config, the action would flag a lot of false positives, so this should make the checks more useful and less noisy.
If you notice any words in the whitelist that actually are typos and should be fixed, feel free to update the config or let me know. For example, I wasn’t sure whether to change “Createable” to “Creatable”, since it appears in a lot of places and might be intentional.
https://github.com/crate-ci/typos