Skip to content

Latest commit

 

History

History
27 lines (19 loc) · 745 Bytes

CONTRIBUTING.md

File metadata and controls

27 lines (19 loc) · 745 Bytes

Contributing

To get setup in the environment and run the tests, take the following steps:

python3 -m venv env
source env/bin/activate
pip install -e '.[test]'

flake8
coverage run && coverage report

Adding a Mailbox Provider

If you know the features for a mailbox provider, simply modify email_normalize.providers adding a new class for the provider. Set the flags in the new class appropriately and add tests.

Test Coverage

Pull requests that make changes or additions that are not covered by tests will likely be closed without review.

In addition, all tests must pass the tests AND flake8 linter. If flake8 exceptions are included, the reasoning for adding the exception must be included in the pull request.