Skip to content

Add ruff formating section to README.md #1051

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
evanepio merged 1 commit into from
Feb 21, 2026
Merged

Add ruff formating section to README.md #1051

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,20 @@ uv run pytest
uv run ruff check --diff .
```

### Formatting

This will check the formatting and report any errors:

```sh
uv run ruff format --check .
```

This will automatically format the code:

```sh
uv run ruff format
```

## Manual Setup (without Dev Containers)

> Keeping this section as a fallback in case of Dev Container issues.
Expand Down