Skip to content

Commit f8e33b0

Browse files
committed
Update instructions for formatter
1 parent 54d3780 commit f8e33b0

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -76,17 +76,17 @@ Ready to contribute? Here's how to set up `bbox_visualizer` for local developmen
7676

7777
7. Format and lint your code:
7878
```bash
79-
# Format with black
80-
uv pip run black .
79+
# Format with ruff
80+
uv run ruff format .
8181
8282
# Run linting checks with ruff
83-
uv pip run ruff check .
83+
uv run ruff check .
8484
8585
# Auto-fix ruff issues where possible
86-
uv pip run ruff check --fix .
86+
uv run ruff check --fix .
8787
8888
# Run tests
89-
uv pip run pytest
89+
uv run pytest
9090
```
9191

9292
8. Commit your changes and push your branch to GitHub:
@@ -107,15 +107,14 @@ Before you submit a pull request, check that it meets these guidelines:
107107
* Add your new functionality into a function with a docstring
108108
* Update the README.md with any new usage instructions
109109
3. The pull request should work for Python 3.8 and above.
110-
4. Make sure all tests pass and the code is formatted with black and passes ruff checks.
110+
4. Make sure all tests pass and the code is formatted and linted with ruff.
111111

112112
## Development Tools
113113

114114
This project uses modern Python development tools:
115115

116116
* **uv**: Fast Python package installer and resolver
117-
* **black**: Code formatter
118-
* **ruff**: Fast Python linter
117+
* **ruff**: Fast Python linter and formatter
119118
* **pytest**: Testing framework
120119

121120
All development dependencies are specified in the `pyproject.toml` file and will be installed when you install the package with the `[dev]` extra.

0 commit comments

Comments
 (0)