CONTRIBUTING.md

How to contribute

If you want to start working on this project, you will need to get familiar with these APIs:

• Writing a flake8 plugin
• Using ast module

It is also recommended to take a look at these resources:

• Missing ast guide

Dependencies

We use poetry to manage the dependencies.

To install them you would need to run two commands:

poetry install
poetry develop

To activate your virtualenv run poetry shell.

Tests

We use pytest and flake8 for quality control. We also use wemake_python_styleguide itself to develop wemake_python_styleguide.

To run all tests:

pytest

This step is mandatory during the CI.

Type checks

We use mypy to run type checks on our code. To use it:

mypy flake8_eradicate.py

This step is mandatory during the CI.

Before submitting

Before submitting your code please do the following steps:

1. Run pytest to make sure everything was working before
2. Add any changes you want
3. Adds tests for the new changes
4. Edit documentation if you have changed something significant
5. Run pytest again to make sure it is still working
6. Run mypy to ensure that types are correct

Other help

You can contribute by spreading a word about this library. It would also be a huge contribution to write a short article on how you are using this project. What are your best-practices?