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

Run common Python lint tools on the project #416

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Run common Python lint tools on the project #416

wants to merge 1 commit into from

Conversation

jdufresne
Copy link
Contributor

Use the following tools:

These tools help:

  1. Autoformat Python code to resemble and common consistent community
    style.
  2. Find and report common code "smells".

This removes some overhead from contributing and reviewing pull requests
as now the tools can do some of the tedious work. As code is added or
removed, this helps to ensure it remains consistently formatted.

Use the following tools:

- black   https://github.com/psf/black
- flake8  https://github.com/PyCQA/flake8
- isort  https://github.com/PyCQA/isort

These tools help:

1. Autoformat Python code to resemble and common consistent community
   style.
2. Find and report common code "smells".

This removes some overhead from contributing and reviewing pull requests
as now the tools can do some of the tedious work. As code is added or
removed, this helps to ensure it remains consistently formatted.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant