Contributing

Contributing to OpenDose-PopPK

Thank you for your interest in contributing! 🎉

Development setup

git clone https://github.com/redkk123/OpenDose-PopPK.git
cd OpenDose-PopPK
pip install -e ".[dev,docs,jupyter]"

Running the test suite

pytest                          # all tests with coverage
pytest -m "not slow"            # fast tests only
pytest tests/test_pk_model.py   # single module

Coverage report is printed to the terminal. Aim for ≥ 90 % on any new code.

Code style

We use black (line length 100) and isort:

black .
isort .
flake8 opendose_poppk tests

Type hints are encouraged. Run mypy with:

mypy opendose_poppk

Building the documentation

cd docs
make html
# open _build/html/index.html

Submitting a pull request

Fork the repository and create a feature branch from main.
Write tests for new functionality.
Ensure pytest and black pass.
Update CHANGELOG.md under [Unreleased].
Open a PR describing what changed and why.

Reporting bugs

Open an issue on GitHub Issues with a minimal reproducible example.

Code of conduct

Be kind, inclusive, and constructive. We follow the Contributor Covenant.