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 linting and formatting #136

Closed
wants to merge 0 commits into from
Closed

Conversation

dragonejt
Copy link
Contributor

@dragonejt dragonejt commented Jul 12, 2024

This PR adds linting using Pylint and formatting using Black, and adds a GitHub Actions workflow to check linting and formatting on each new push or PR. This is functionally optional, but sets a guideline for formatting so there aren't any formatting conflicts or code smells.

Changes

  • Add black. Run the black formatter with black ..
  • Add pylint. Run pylint python linter with pylint <module>.
  • Format code using black
  • Add GitHub Actions workflow that checks linting and formatting on each new push or PR

Testing

  • Unit Tests are succeeding
  • Linting and Formatting checking is working (Pylint is complaining though due to code smells we can fix later)

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.

None yet

1 participant