Skip to content

Commit

Permalink
Merge branch 'main' into feature/gh-page-action-setup
Browse files Browse the repository at this point in the history
  • Loading branch information
minhnh authored Nov 21, 2024
2 parents 1169b09 + 564be53 commit 5f36280
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 5f36280

Please # to comment.