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
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.
Pull Request Details
This PR adds a spell-check action, that should automatically spell-check any opened or changed PRs (excluding drafts) and comment with any spelling errors. There are also options for automatically fixing mistakes or ignoring words etc.
Issue Number: N/A
Type: Bug / Feature / Documentation / Other (Delete as appropriate)
Description of the Change
This seemed to be by far the most starred action related to spell-checking. There may be further configuration required e.g. adding dictionaries, adding and modifying expect/ignore lists.
I set it to only run against PRs (not drafts) and it will only run against the specific files which the PR edited.
Verification Process
Followed the config docs for the action. I also added dependabot which will automatically open a PR if/when the spellcheck action is updated. That will allow us to check release notes and update to newer versions in a timely but informed way.
Additional Work Required
Possibly will need additional work... It's hard to check actions without actually running them on the repo 🤷