CI: Format codebase with black and add black to CI #212
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
This commit reformats the entire codebase using the 'black' code formatter to ensure a consistent and readable style. The formatting was applied with the command: `black --line-length=120 .` To maintain this style, a new GitHub Actions workflow (`.github/workflows/ci.yml`) has been added. This CI job automatically runs `black --check` on all pushes and pull requests. Automating style enforcement is crucial for project health because it: - **Improves Code Review Efficiency:** Reviewers can focus on the core logic and functionality of a change, rather than spending time on manual formatting nitpicks. - **Ensures Consistency:** A uniform style makes the codebase easier to read, understand, and maintain for everyone. - **Lowers Contribution Barrier:** Contributors don't have to guess the project's style rules; the linter provides immediate, automated feedback.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 PR reformats the entire codebase using the 'black' code formatter to ensure a consistent and readable style. The formatting was applied with the command:
black --line-length=120 .To maintain this style, a new GitHub Actions workflow (
.github/workflows/ci.yml) has been added. This CI job automatically runsblack --checkon all pushes and pull requests.Automating style enforcement is beneficial for project health because it:
You can see the workflow running in the following example PR (it fails on purpose): Ana06#5. It should also run in this PR (and not fail as the offenses are fixed):