Skip to content

Integrate linter: flake8  #218

@michaeldiamant

Description

@michaeldiamant

Problem

A linter like flake8 catches issues like unused imports, and lack of adherence to language standards. It's ideal to catch these issues during the CI process because it provides a consistent approach to writing software in all parts of a repo.

Solution

While multiple linters exist, I propose starting with flake8 and later swapping out and/or adding others. #213 illustrates partial integration and can be extended.

A full solution includes:

  • CI process runs flake8.
  • Ensure CI and local building share the same steps.
    • Presumably, a script can be written to accomplish the goal. I'm being vague to allow freedom for interpretation.
  • Upon merge, flake8 does not find errors. Implies fixing errors for the to-be-agreed upon flake8 configuration.
  • Add pyteal repo docs explaining flake8 usage.

Dependencies

N/A

Urgency

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions