You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,9 +3,10 @@ Thanks for contributing to this package!
3
3
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.
4
4
5
5
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
9
10
- If you're adding a new feature, mention it in the [CHANGELOG.md](CHANGELOG.md) file under the _Unreleased_ section
10
11
11
12
Please only send the PR once all of the above is done, thanks!
0 commit comments