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

Configure pre-commit to do the static analysis #55

Merged
merged 3 commits into from
Nov 15, 2024
Merged

Conversation

peterfpeterson
Copy link
Member

@peterfpeterson peterfpeterson commented Nov 14, 2024

The main purpose of this is to move static analysis checks to pre-commit and make it happy. The main files to look at are .pre-commit-config.yaml and pyproject.toml. Almost everything else is a formatting change, fixing a static analysis warning, or suppressing a warning. Most warnings were suppressed rather than changed because they involved naming conventions and ignored arguments.

Check list for the pull request

  • I have read the [CONTRIBUTING]
  • I have read the [CODE_OF_CONDUCT]
  • I have added tests for my changes
  • I have updated the documentation accordingly

Check list for the reviewer

  • I have read the [CONTRIBUTING]
  • I have verified the proposed changes
  • best software practices
    • all internal functions have an underbar, as is python standard
    • clearly named variables (better to be verbose in variable names)
    • code comments explaining the intent of code blocks
  • All the tests are passing
  • The documentation is up to date
  • code comments added when explaining intent

Manual test for the reviewer

References

@peterfpeterson peterfpeterson marked this pull request as ready for review November 14, 2024 22:07
@Kvieta1990 Kvieta1990 merged commit 768aad2 into master Nov 15, 2024
2 checks passed
@Kvieta1990 Kvieta1990 deleted the pre-commit-config branch November 15, 2024 02:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants