Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 766 Bytes

CONTRIBUTING.md

File metadata and controls

35 lines (25 loc) · 766 Bytes
Raw

Contributing to aioitertools

Preparation

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

$ pyenv install 3.12
$ pyenv shell 3.12

Setup

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

$ 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