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 ```