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

Establish Python formatting guidelines #24

Open
benpankow opened this issue Sep 27, 2019 · 0 comments
Open

Establish Python formatting guidelines #24

benpankow opened this issue Sep 27, 2019 · 0 comments

Comments

@benpankow
Copy link
Contributor

benpankow commented Sep 27, 2019

It would be good to set up some sort of linting/formatting requirement before the codebase grows. I'm partial to black, which is part of the PSF. It has plugin support for most major editors and can be set up with CI to check for proper formatting at PR time.

flake8 checks code compliance with the PEP 8 Python style guide. We could run this after black to catch any other linting errors. The downside of solely using flake8 is that it won't fix these issues for you - black will happily format your code and fix most problems.

Of course, introducing style requirements does raise the bar to commit a bit. If we do implement style guidelines, we should ensure it's as easy as possible to install and run the needed tools.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant