2018-06-27 02:56:33 +00:00
|
|
|
# Contributing to aioitertools
|
|
|
|
|
|
|
|
|
|
## Preparation
|
|
|
|
|
|
2019-10-20 02:51:57 +00:00
|
|
|
You'll need to have Python 3.6 available for testing.
|
|
|
|
|
I recommend using [pyenv][] for this:
|
2018-06-27 02:56:33 +00:00
|
|
|
|
|
|
|
|
$ pyenv install 3.6.5
|
|
|
|
|
$ pyenv shell 3.6.5
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Setup
|
|
|
|
|
|
2019-10-20 02:51:57 +00:00
|
|
|
Create a fresh development enviroment, and install the
|
|
|
|
|
appropriate tools and dependencies:
|
2018-06-27 02:56:33 +00:00
|
|
|
|
|
|
|
|
$ cd <path/to/aioitertools>
|
2019-10-20 02:51:57 +00:00
|
|
|
$ make venv
|
|
|
|
|
$ source .venv/bin/activate
|
2018-06-27 02:56:33 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## 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
|
2019-10-20 02:51:57 +00:00
|
|
|
* Used `make format` to format code appropriately
|
|
|
|
|
* Validated and tested code with `make lint test`
|
2018-06-27 02:56:33 +00:00
|
|
|
|
|
|
|
|
[pyenv]: https://github.com/pyenv/pyenv
|
