Add a Github Workflow to check formatting with black and reformat files #321
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
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.
This MR adds a CI check to ensure that all files are well formatted using Python black. To get the workflow passing I went ahead and reformatted all of the files using black.
I also investigated only checking files that have changed in the current branch to progressively reformat the repo, but this made the CI more complex and ultimately I dropped it and decided to just rip the 🩹 off.
I hope this is helpful. Once this is merged I would be happy to continue to add workflow support for the steps listed in #318
Note: This MR is a bit easier to review if you hide whitespace changes