Contributing
Contributing to gen_surv
Thank you for taking the time to contribute to gen_surv! This document provides a brief overview of the recommended workflow for feature requests and pull requests.
Getting Started
Fork the repository and create your feature branch from
main
.Install dependencies with
poetry install --with dev
. This installs all packages needed for development, including the optional dependencyscikit-survival
. On Debian/Ubuntu you may needbuild-essential gfortran libopenblas-dev
to build it.Run
pre-commit install
to enable style checks and execute them withpre-commit run --all-files
.Ensure the test suite passes with
poetry run pytest
.If you add a feature or fix a bug, update
CHANGELOG.md
accordingly.
Submitting Changes
Commit your changes with clear messages.
Push to your branch and open a pull request.
Ensure your PR description explains the motivation and summarizes your changes.
We appreciate your contributions and feedback!