Merge branch dev/pre-commit-hook #156
Open
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
The defined configuration is inspired by [flake8] and [black] [flake8]: https://github.com/PyCQA/flake8/blob/main/.pre-commit-config.yaml [black]: https://github.com/psf/black/blob/main/.pre-commit-config.yaml
Add style guide for commit messages Add tool guide to enforce rules
gierle
requested review from
arberzela,
yashsmehta and
crwhite14
as code owners
Neonkraft
reviewed
Mar 23, 2023
.pre-commit-config.yaml
Outdated
| # According to this blog post (https://jaredkhan.com/blog/mypy-pre-commit) | ||
| # one should consider running mypy on all files rather than on only the committed changes | ||
| # since the changes can break dependencies elsewhere (e.g. function naming) | ||
| - repo: https://github.com/pre-commit/mirrors-mypy |
There was a problem hiding this comment.
I agree. Cleaning up the entire repo with mypy is an item on our list. We should enforce mypy in pre-commit hooks only once we've done that.
Neonkraft
reviewed
Mar 23, 2023
.pre-commit-config.yaml
Outdated
| rev: 22.12.0 | ||
| hooks: | ||
| - id: black-jupyter # supports .py and .ipynb files | ||
| args: [--line-length=79, --target-version=py37] |
There was a problem hiding this comment.
Optimal line length is a bitterly contested subject, but I personally find 79 to be too short. I've seen other projects that use 88. I'd much prefer that.
Changes: - line length 79->88 - stop enforcing mypy in pre-commit hooks, until the repo is cleaned using mypy
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.
Add uniform style guide based on conventional commits and AngularJS.
Add optional tools:
Revise pre-commit hook configuration