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 CI for code quality #69

Open
lukethehuman opened this issue Sep 3, 2024 · 0 comments
Open

Implement CI for code quality #69

lukethehuman opened this issue Sep 3, 2024 · 0 comments

Comments

@lukethehuman
Copy link
Collaborator

lukethehuman commented Sep 3, 2024

Related to #70

Add a continuous integration pipeline to check for code quality. Protect main branch from merge requests where this CI fails. Configure linters to run in the CI with appropriate config settings.

Suggest flake8 and pylint with minimal configurations.

One custom config we will likely need is increasing the valid number of args to a class e.g. dataclasses. As we can't really get around the high number of parameters some of the components and assemblies are going to have, and breaking these down into a tree structure simply to satisfy a max_args=5 condition on the linter rather than make some meaningful distinction, is probably not useful.

I would suggest we enforce a line limit. black is an excellent tool for automatically reformatting code to a given line limit, which would reduce the person-time required to apply the limit to existing code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant