DOC: add a pre-commit hook to spell-check markdown files in docs/#3122
Open
ev-br wants to merge 1 commit intoAI-Hypercomputer:mainfrom
Open
DOC: add a pre-commit hook to spell-check markdown files in docs/#3122ev-br wants to merge 1 commit intoAI-Hypercomputer:mainfrom
ev-br wants to merge 1 commit intoAI-Hypercomputer:mainfrom
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
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.
Description
Add a pre-commit hook for spell-checking markdown docs in the
docs/folder.When typo's found, interactively prompt the user whether to block the commit, ignore the word, or add it to the project-specific dictionary.
Spell-checking itself relies on GNU Aspell utility, http://aspell.net/, which needs to be installed separately.
The wrapper is minimally modified from https://github.com/mprpic/git-spell-check to be used with the
pre-commitframework.The original version is GPL licensed, and this one is clearly a derivative.
Please advise if this is a problem. If it is, one solution could be to package this hook as a separate repository instead of a local hook. That way,
maxtextrepository will only carry the hook configuration, which is clearly not copyrightable.Checklist
Before submitting this PR, please make sure (put X in square brackets):
gemini-reviewlabel.