Contributing

We are happy to welcome contributions! This guide will help you get started with contributing to the hypertool project.

Set up

Download GIT repository

Clone the hypertool repository from eclipse research labs.

$ git clone https://gitlab.eclipse.org/eclipse-research-labs/hyper-ai-project/hypertool.git
$ cd hypertool

Creating a virtual environment

Create and activate a Python virtual environment to isolate dependencies.

$ python3 -m venv venv
$ source venv/bin/activate
Note:

The target Python version is 3.11.

Install the dependencies

Install required Python packages listed in the requirements file.

$ pip install --upgrade pip
$ pip install -r requirements.txt

Install hypertool in editable mode

Install the project in editable mode so changes reflect immediately.

$ pip install -e .

Check the installation

Verify that the hypertool CLI is installed.

$ hypertool --version

Set up the pre-commit hooks

Install pre-commit hooks to automatically linting and formatting.

$ pre-commit install

How to contribute

Create a new branch

Create a feature branch to work on your changes.

$ git checkout -b my-feature-branch

Make your changes and commit

Stage and commit your changes with a meaningful commit message.

$ git add .
$ git commit -m "Add my-feature-branch"
Notes:

  1. If this commit is mentioned by an issue, use the issue ID in the commit message. For example: refactor #1: Updated annotation logic to print all at once

  2. The pre-commit hooks may reformat your code to follow style guidelines.

Push your changes

Push your branch to the remote repository to open a merge request.

$ git push origin my-feature-branch