Add pre-commit hooks for black formatting and spell-checking#3896
Open
bernalde wants to merge 3 commits intoPyomo:mainfrom
Open
Add pre-commit hooks for black formatting and spell-checking#3896bernalde wants to merge 3 commits intoPyomo:mainfrom
bernalde wants to merge 3 commits intoPyomo:mainfrom
Conversation
- Add .pre-commit-config.yaml with black and typos hooks - Update contribution_guide.rst with optional pre-commit setup instructions - Hooks are optional but help catch formatting/spelling issues locally before CI
numpy arrays have a .flags.writeable property, which is not a typo but the correct numpy API naming.
This reverts commit 5fafe0b.
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.
Fixes #3895
Summary
Adds optional pre-commit hooks to help contributors catch formatting and spelling issues locally before CI.
Changes
.pre-commit-config.yamlwith:blackhook (exclusions matchpyproject.toml)typoshook (uses existing.github/workflows/typos.tomlconfig)contribution_guide.rstwith setup instructionsUsage (Optional)
After setup, hooks run automatically on
git commitfor staged files only.Legal Acknowledgement
By contributing to this software project, I have read the contribution guide and agree to the following terms and conditions for my contribution: