Skip to content

Code Linter addition [pep8, code-quality, ci/actions]  #526

@isaac-philip

Description

@isaac-philip

Problem

We can have code that comes up which maybe syntactically incorrect and break.
Yes we have certain high level init tests, for e.g. which deals with the main module jira or other atlassian products for initialising them but having a linter gives us additional benefits too such has adhering to PEP8 guidelines.

Having this will give us ease of mind that the code that is coming in will not be having issues.

Flow can be,

Linting -> Tests

Solution

Addition of code Linter to check for any issues that could arise due to syntactical errors.

In addition we can aim to achieve a standard of code aimed at by PEP8 guidelines.

Starting with number of characters per line, which for e.g. could be 90 ?

Suggestion to be used

  • This linter can run in pre-commit to avoid explicit running locally prior to pushing -> https://pre-commit.com/ for good help
  • I am interested in using github-actions for the job.

Next steps would be to hook up tests/unit to this so we have flow Linting -> Tests

@gonchik and other maintainers, please let me know your views and we can proceed.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions