Skip to content

Set Up Code Linting #2

@idodin

Description

@idodin

Similar to #1 , it is useful to additionally set up code-linting to ensure that the system code conforms to a style guideline (PEP8). YAPF is a useful tool to do so as it can format files to conform to a guideline and check whether files conform to a guideline (as can pep8ify and autopep8), but will additionally format code to make it look nice.

Style checks can be added to the Travis Build Job to return errors if contributors have not linted their code.

Pre-commit hooks can also be created (but must then be set up by contributors individually) to automate code linting before commits. A note on this is that users must then manually stage changes applied by YAPF.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions