Contributing#

Development Setup#

  1. Clone the repository:

    git clone https://github.com/YuantianDing/boundlab.git
cd boundlab

  2. Install in development mode:

    pip install -e ".[dev]"

  3. Run tests:

    pytest

Building Documentation#

cd docs
make html

The built documentation will be in docs/_build/html/.

Code Style#

  • Follow PEP 8

  • Use type hints

  • Write docstrings in Google style