Contributing to nnbench

Thank you for your interest in contributing to this project!

We appreciate issue reports, pull requests for code and documentation, as well as any project-related communication through GitHub Discussions.

Getting Started

To get started with development, you can follow these steps:

1. Clone this repository:

   git clone https://github.com/aai-institute/nnbench.git
   

2. Navigate to the directory and install the development dependencies into a virtual environment:

   cd nnbench
   python3 -m venv venv --system-site-packages
   source venv/bin/activate
   python -m pip install -r requirements-dev.txt
   python -m pip install -e . --no-deps
   

3. After making your changes, verify they adhere to our Python code style by running pre-commit:

   pre-commit run --all-files
   

   You can also set up Git hooks through pre-commit to perform these checks automatically:

   pre-commit install
   

4. To run the tests, just invoke pytest from the package root directory:

   pytest
   

Updating dependencies

Dependencies should stay locked for as long as possible, ideally for a whole release. If you have to update a dependency during development, you should do the following:

1. If it is a core dependency needed for the package, add it to the dependencies section in the pyproject.toml.
2. In case of a development dependency, add it to the dev section of the project.optional-dependencies table instead.
3. Dependencies needed for documentation generation are found in the docs sections of project.optional-dependencies.

After adding the dependency in either of these sections, use pip-compile to pin all dependencies again:

python -m pip install --upgrade pip-tools
pip-compile --extra=dev --no-annotate --output-file=requirements-dev.txt pyproject.toml

Tip

Since the official development version is Python 3.11, please run the above commands in a virtual environment with Python 3.11.