Contributing#
blackdoc
uses several tools to ensure consistency (this is enforced using CI):
black for standardized code formatting
flake8 for code quality
isort for standardized ordering of imports
To avoid having to remember to manually run these tools before committing, using pre-commit is possible. After installing, enable it using
python -m pip install pre-commit
# or
conda install -c conda-forge pre-commit
pre-commit install
When modifying the test data in blackdoc/tests/data/format.py
, make sure the ranges are
correct using
python -m blackdoc.tests.data format
where format
is a placeholder for the name of one of the supported formats.