Skip to content

Commit 0267e99

Browse files
committed
Update contributing guide
1 parent 6b05531 commit 0267e99

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,27 @@
22

33
## Preparation
44

5-
You'll need to have Python 3.8 or newer available for testing.
6-
I recommend using [pyenv][] for this:
5+
aioitertools uses [uv][] to manage environments and dependencies, and `make`
6+
to run tests and linters.
7+
8+
You'll need to have Python 3.9 or newer available for testing:
79

810
```sh
9-
$ pyenv install 3.12
10-
$ pyenv shell 3.12
11+
$ uv python pin 3.14
1112
```
1213

13-
## Setup
14+
## Testing
1415

15-
Create a fresh development enviroment, and install the
16-
appropriate tools and dependencies:
16+
Run the test suite:
1717

18-
```sh
19-
$ cd <path/to/aioitertools>
20-
$ make venv
21-
$ source .venv/bin/activate
18+
```shell-session
19+
$ make test
20+
```
21+
22+
Run the linters:
23+
24+
```shell-session
25+
$ make lint
2226
```
2327

2428
## Submitting
@@ -32,4 +36,4 @@ that you have done the following:
3236
* Used `make format` to format code appropriately
3337
* Validated and tested code with `make test lint`
3438

35-
[pyenv]: https://github.com/pyenv/pyenv
39+
[uv]: https://docs.astral.sh/uv/

0 commit comments

Comments
 (0)