software-gardening / almanack

An open-source handbook of applied guidance and tools for sustainable software development and maintenance.
https://software-gardening.github.io/almanack
BSD 3-Clause "New" or "Revised" License
0 stars 2 forks source link

Add code quality linting checks via `ruff` through `pre-commit` #57

Closed d33bs closed 3 months ago

d33bs commented 3 months ago

Description

This PR adds a few code quality linting checks via ruff to help us develop the almanack Python package and related. These checks are performed through the existing pre-commit workflows related to the repository. They're also meant to perform checks gradually, meaning new code is checked but we haven't retroactively changed any other code to meet these standards. That said, some minor changes to existing code are applied to help pass the initial settings.

Through these changes we will use pyflakes, pylint, mccabe, and ruff-specific rules to check code.

Thanks for any feedback you may have!

Closes #56

What is the nature of your change?

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

d33bs commented 3 months ago

Thanks @gwaybio ! Merging this in.