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

Housekeeping: Add linter, CI #40

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Housekeeping: Add linter, CI #40

wants to merge 2 commits into from

Conversation

pygeek
Copy link

@pygeek pygeek commented Dec 10, 2022

What was done

  • Update this library to follow PEP8.
  • Update this library to use a linter (black).
  • Update this library to use Continuous Integration (GitHub Actions).
  • Add pre-commit for local development.

What was NOT done

Breaking changes.
Changes that affect library behavior.

Rationale

  • Following PEP8, and more generally, Python idiosyncrasies increases readability and maintainability.
  • Adding a linter, specifically black, identifies PEP8 violations and automatically formats (locally) code to conform with PEP8.
  • Adding Continuous Integration (via Github Actions) ensures that violations are presented during a Pull Request and can be made to be a prerequisite to merging into develop / main (must be done by repository's maintainer)).
  • Adding pre-commit allows developers to ensure that linters are run automatically. By running pre-commit install it installs .git/hooks (by default, on commit).

@gerrrg
Copy link
Collaborator

gerrrg commented Jul 11, 2023

I may revisit this. Will likely pull in the linter/GH action in one PR and then update the source files in another.

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