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

Implement Python's in-built formatters and error checkers #44

Open
BenWinchester opened this issue Jul 1, 2021 · 0 comments
Open

Implement Python's in-built formatters and error checkers #44

BenWinchester opened this issue Jul 1, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@BenWinchester
Copy link
Collaborator

A new set of coding requirements will be introduced, which will be automated by .github runs, and would consist of

  • mypy, with agreed-upon enforcement rules;
  • pylint, with agreed-upon enforcement rules;
  • black, with an agreed-upon line length and other code format tweaks available;
  • yamllint, with an agreed-upon file format;
  • pytest, which would be implemented only when automated module and component unit testing is included in CLOVER.
    All GitHub workflows can be overridden using Admin permissions, but implementing the workflows would ensure that a red flag was placed on all pull requests that would, after merging with the master branch, result in the code failing any of the enforced checks. An automated email would also be sent out to administrators of the repository, informing them that a failed run of the automated tests was carried out.
@BenWinchester BenWinchester added the enhancement New feature or request label Jul 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant