DEVELOP.md

Code Style and Lint

We use black as the code formatter, the best way to use it is to install the pre-commit hook, it will automatically format the code before each commit

Install pre-commit before commit

pip install pre-commit
pre-commit install

Pre-commit will automatically format the code before each commit, It can also be executed manually on all files

pre-commit run --all-files

Install Locally with Test Dependencies

pip install -e .[test]

Unit-test

We use pytest to write unit tests, and use pytest-cov to generate coverage reports

pytest -v # Run unit-test
pytest --cov=duetector --cov-report=html # Generate coverage reports

Run unit-test before PR, ensure that new features are covered by unit tests