Add precommit configuration and refactor files - #182
Merged
Merged
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.
I have several ideas for improvements and fixes in this repository. However I think it would be beneficial to follow the same coding standard when contributing to the repository first. For that purpose I have added precommit configuration and run it on all files.
To use it when developing locally:
Install precommit package:
Install in the repository root:
From now on every commit will run black and isort tools to autoformat the code (first run after installation will take the longest, next ones should be seconds). If the formatters end up formatting the file, the commit will be cancelled and need to be redone.
In the future we can add Github action to verify if new PRs used precommits to autoformat the files.