Contributor Guide

Thank you for your interest in improving this project. This project is open-source under the GPL-3 license and highly welcomes contributions in the form of bug reports, feature requests, and pull requests.

Here is a list of important resources for contributors:

How to report a bug

Report bugs on the Issue Tracker.

How to request a feature

Request features on the Issue Tracker.

How to set up your development environment

  1. Fork the repository on GitHub.

  2. Make a new conda environment with Python 3.11, 3.12, or 3.13.

  3. pip install poetry : we use poetry to manage dependencies

  4. pip install poetry-plugin-export

  5. poetry install : this will install all dependencies

  6. Test whether the installation was successful by running the following command:

    $ drevalpy --run_id my_first_run --models NaiveDrugMeanPredictor ElasticNet --dataset TOYv1 --test_mode LCO

  1. Visualize the results by running the following command:

    $ drevalpy-report --run_id my_first_run --dataset TOYv1

How to test the project

Unit tests are located in the tests directory, and are written using the pytest testing framework.

How to submit changes

Open a pull request to submit changes to this project against the development branch.

Your pull request needs to meet the following guidelines for acceptance:

  • The code must pass all tests.

  • Include unit tests. This project maintains a high code coverage.

  • If your changes add functionality, update the documentation accordingly.

To run linting and code formatting checks before committing your change, you can install pre-commit as a Git hook by running the following command:

$ nox --session=pre-commit -- install

It is recommended to open an issue before starting work on anything.

How to build and view the documentation

This project uses Sphinx together with several extensions to build the documentation. To build the documentation, change into the docs/ directory and run:

$ make html

The generated static HTML files can be found in the _build/html folder. Simply open them with your favorite browser.