File: CONTRIBUTING.md

package info (click to toggle)
python-aioitertools 0.12.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 348 kB
  • sloc: python: 2,025; makefile: 49
file content (35 lines) | stat: -rw-r--r-- 766 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# Contributing to aioitertools

## Preparation

You'll need to have Python 3.8 or newer available for testing.
I recommend using [pyenv][] for this:

```sh
$ pyenv install 3.12
$ pyenv shell 3.12
```

## Setup

Create a fresh development enviroment, and install the
appropriate tools and dependencies:

```sh
$ cd <path/to/aioitertools>
$ make venv
$ source .venv/bin/activate
```

## Submitting

Before submitting a pull request, please ensure
that you have done the following:

* Documented changes or features in README.md
* Added appropriate license headers to new files
* Written or modified tests for new functionality
* Used `make format` to format code appropriately
* Validated and tested code with `make test lint`

[pyenv]: https://github.com/pyenv/pyenv