Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

style: autoformat code and add github action to check formatting #51

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

brycedrennan
Copy link

@brycedrennan brycedrennan commented Nov 25, 2022

Automatic code formatting reduces mental overhead for developers.

  • Code style is consistent in this repo and across other repos
  • Future diffs will not have anything relating to style changes

Code can be formatted by:

  • pip install black isort
  • make af (short for autoformat)

A github action that automatically checks code formatting is also added here, ensuring consistent style going forward.

The specific code formatter used here is extremely safe to use (as in it doesn't break code), very fast, and makes smart choices about formatting.

@brycedrennan brycedrennan changed the title autoformat code and add github action to check formatting style: autoformat code and add github action to check formatting Nov 25, 2022
@miao-ju miao-ju added wontfix This will not be worked on and removed wontfix This will not be worked on labels Dec 16, 2022
@dmarx dmarx added the enhancement New feature or request label Jan 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants