ci: add ruff formatter and linter #216
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Linting is the process of automatically checking code for style, syntax, and other issues. Code formatting ensures code meets a consistent style. Together they help ensure the codebase is consistent and clean. Developers don't have to worry about formatting and reviewers can focus on code rather than style preferences.
CapyMOA uses the ruff linter to enforce both. Checks are run automatically using GitHub actions on every pull request.
You will need to run
ruff
locally before committing changes. Ruff is installed as part of the development dependencies.To format files run:
ruff format # or python -m invoke format
To lint files run:
ruff check # or python -m invoke lint
Furthermore,
python -m invoke commit
will run the linter and check that formatting is correct before committing.These explanations and instructions have been added to
docs/contributing/vcs.md