From 0a2a10e165a7b9231b22bf31e4c848b133740569 Mon Sep 17 00:00:00 2001 From: yakhyo Date: Wed, 26 Nov 2025 00:05:40 +0900 Subject: [PATCH] docs: Update README.md --- README.md | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1d94db7..5f2c290 100644 --- a/README.md +++ b/README.md @@ -394,12 +394,28 @@ pip install -e ".[dev]" # Run tests pytest - -# Format code -black uniface/ -isort uniface/ ``` +### Code Formatting + +This project uses [Ruff](https://docs.astral.sh/ruff/) for linting and formatting. + +```bash +# Format code +ruff format . + +# Check for linting errors +ruff check . + +# Auto-fix linting errors +ruff check . --fix +``` + +Ruff configuration is in `pyproject.toml`. Key settings: +- Line length: 120 +- Python target: 3.10+ +- Import sorting: `uniface` as first-party + ### Project Structure ```