Skip to content

Introduce pre-commit configuration #280

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.

Sign up for GitHub

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

Merged
bgunebakan merged 2 commits into from
Jun 19, 2026
Merged

Introduce pre-commit configuration #280

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f588de3
Introduce pre-commit configuration
bgunebakan Jun 19, 2026
ce95d2f
Add docs
bgunebakan Jun 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
repos:
# Mirrors CI: poe lint → `ruff format --check` + `ruff check .`
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.15.13
Comment on lines +3 to +4

@amotl amotl Jun 19, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi. It is difficult to keep the version in sync with the version written in pyproject.toml, right? Maybe there is a better solution for that today?

@bgunebakan bgunebakan Jun 19, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately no, pre-commit config does not support dynamic version definition.

hooks:
- id: ruff
exclude: ^bin/
- id: ruff-format
exclude: ^bin/

13 changes: 13 additions & 0 deletions DEVELOP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,19 @@ Format code:

poe format

## Pre-commit hooks

The repository ships a `.pre-commit-config.yaml` that runs the same linters
as CI (`ruff check` + `ruff format --check`) on every commit. To install:

pip install pre-commit
pre-commit install

After that, linting runs automatically before each `git commit`. To run it
manually across all files:

pre-commit run --all-files


## Preparing a release

Expand Down