diff --git a/README.md b/README.md index 586739f..553c708 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,16 @@ Common installation patterns: - Install with optional dependencies (as specified in [`pyproject.toml`](./pyproject.toml), here `test`): `pip install ".[test]"` -Note: double quote is needed in `zsh` to avoid "no matches" error. +> **_NOTE:_** double quote is needed in `zsh` to avoid "no matches" error. + +## Linting + +The package uses [ruff](https://docs.astral.sh/ruff/) for linting, +with both a [pre-commit hook](./.pre-commit-config.yaml) +and a checking step in the [package build GitHub action](./.github/workflows/python-package.yml). +Checks should use `ruff`'s [default rules](https://docs.astral.sh/ruff/rules/) +except from line length (specified in [`pyproject.toml`](./pyproject.toml)). +A [plugin](https://github.com/astral-sh/ruff-vscode) is also available for VSCode. ## Python version in GitHub action