Skip to content
Snippets Groups Projects
Commit 088315eb authored by Michael Loukeris's avatar Michael Loukeris
Browse files

docs: Added CONTRIBUTING.rst

parent d0001d6d
No related branches found
No related tags found
No related merge requests found
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.
.. code-block:: bash
$ 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.
.. code-block:: bash
$ 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.
.. code-block:: bash
$ pip install --upgrade pip
$ pip install -r requirements.txt
Install hypertool in editable mode
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Install the project in editable mode so changes reflect immediately.
.. code-block:: bash
$ pip install -e .
Check the installation
^^^^^^^^^^^^^^^^^^^^^^
Verify that the hypertool CLI is installed.
.. code-block:: bash
$ hypertool --version
Set up the pre-commit hooks
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Install pre-commit hooks to automatically linting and formatting.
.. code-block:: bash
$ pre-commit install
How to contribute
-----------------
Create a new branch
^^^^^^^^^^^^^^^^^^^^
Create a feature branch to work on your changes.
.. code-block:: bash
$ git checkout -b my-feature-branch
Make your changes and commit
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Stage and commit your changes with a meaningful commit message.
.. code-block:: bash
$ 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.
.. code-block:: bash
$ git push origin my-feature-branch
=========
Hypertool
=========
Contribution
============
Please follow the `Contribution Guidelines <CONTRIBUTING.rst>`_ to get started.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment