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

Add CI checks #3

Closed
joelspadin opened this issue Aug 24, 2024 · 0 comments · Fixed by #4
Closed

Add CI checks #3

joelspadin opened this issue Aug 24, 2024 · 0 comments · Fixed by #4
Labels
enhancement New feature or request

Comments

@joelspadin
Copy link
Collaborator

joelspadin commented Aug 24, 2024

  • Add a GitHub workflow that runs pre-commit checks. Make sure it runs on PRs.
  • Add a pre-commit check and VS Code settings to run a type checker such as mypy or pyright.
  • Add a pre-commit check for pylint.
@joelspadin joelspadin added the enhancement New feature or request label Aug 24, 2024
joelspadin added a commit to joelspadin/zmk-cli that referenced this issue Aug 25, 2024
Added a GitHub workflow to run pre-commit, pylint, and pyright.

pylint and pyright are not included as pre-commit checks, because they
need to analyze the project as a whole, not just the changed files, and
they do not work correctly in an isolated environment without having
access to dependencies.

Adjusted the pylint configuration to ignore diagnostics that are either
not useful or duplicate those reported by pyright.

Fixed all type errors reported by pyright.

Added VS Code extension recommendations for all the formatting and
linting tools, and enabled type checking in VS Code.

Fixes zmkfirmware#3
joelspadin added a commit to joelspadin/zmk-cli that referenced this issue Sep 14, 2024
Added a GitHub workflow to run pre-commit, pylint, and pyright.

pylint and pyright are not included as pre-commit checks, because they
need to analyze the project as a whole, not just the changed files, and
they do not work correctly in an isolated environment without having
access to dependencies.

Adjusted the pylint configuration to ignore diagnostics that are either
not useful or duplicate those reported by pyright.

Fixed all type errors reported by pyright.

Added VS Code extension recommendations for all the formatting and
linting tools, and enabled type checking in VS Code.

Fixes zmkfirmware#3
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

Successfully merging a pull request may close this issue.

1 participant