Skip to content

Commit bf0d878

Browse files
committed
mention new lint and uv in contributing docs
1 parent c3b1410 commit bf0d878

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@ Thanks for contributing to this package!
33
Before sending a PR, please make sure you checked the [python test workflow](.github/workflows/python-test.yml) and ran it locally, either using [act](https://nektosact.com) or by executing the workflow actions yourself.
44

55
TL;DR:
6-
- Format all code with Black
7-
- Provide type annotations with mypy
8-
- Write and run tests with pytest
6+
- Format and lint all code with [ruff](https://docs.astral.sh/ruff/) (use `uv run ruff format .` and `uv run ruff check .`)
7+
- Provide type annotations with mypy (`uv run mypy pythonosc examples`)
8+
- Write and run tests with pytest (`uv run pytest`)
9+
- Use [uv](https://docs.astral.sh/uv/) for package management and environment isolation
910
- If you're adding a new feature, mention it in the [CHANGELOG.md](CHANGELOG.md) file under the _Unreleased_ section
1011

1112
Please only send the PR once all of the above is done, thanks!

0 commit comments

Comments
 (0)