mirror of
https://github.com/yakhyo/uniface.git
synced 2025-12-30 09:02:25 +00:00
docs: Update README.md
This commit is contained in:
24
README.md
24
README.md
@@ -394,12 +394,28 @@ pip install -e ".[dev]"
|
|||||||
|
|
||||||
# Run tests
|
# Run tests
|
||||||
pytest
|
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
|
### Project Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user