This repository has been archived by the owner on Mar 3, 2022. It is now read-only.
chore(build): add spellchecker github action #928
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
Add a github action that can detect spell errors and report on the PR. For terms that are not part of the standard dictionary, the new words can be added to one of the following files: - hack/cspell-contributors.txt - company and user names - hack/cspell-ignore.txt - random text that is part of code output - hack/cspell-words.txt - technology words Signed-off-by: kmova <[email protected]>
|
Deploy preview for openebs-docs-staging ready! Built with commit dd804c7 https://deploy-preview-928--openebs-docs-staging.netlify.app |
There was a problem hiding this comment.
@kmova I have done with my review. Please go through the comments.
Signed-off-by: kmova <[email protected]>
ranjithwingrider
approved these changes
May 4, 2021
kmova
added a commit
that referenced
this pull request
May 16, 2021
Add a github action that can detect spell errors and report on the PR. For terms that are not part of the standard dictionary, the new words can be added to one of the following files: - hack/cspell-contributors.txt - company and user names - hack/cspell-ignore.txt - random text that is part of code output - hack/cspell-words.txt - technology words Signed-off-by: kmova <[email protected]>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Add a GitHub workflow that can detect spell errors and report on the PR.
This commit also includes the fixes for the initial errors reported by this tool.
To verify this locally prior to commit:
npm install -g cspellcspell --config ./cSpell.json "**/*.md"Sometimes the tool will display some valid words as errors since they are not part of a standard dictionary. You can customize the tool by adding the new words can be added to one of the following files:
Signed-off-by: kmova [email protected]