Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
H
hypertool
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Deploy
Releases
Model registry
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Eclipse Research Labs
HYPER-AI Project
hypertool
Commits
088315eb
Commit
088315eb
authored
1 month ago
by
Michael Loukeris
Browse files
Options
Downloads
Patches
Plain Diff
docs: Added CONTRIBUTING.rst
parent
d0001d6d
No related branches found
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
CONTRIBUTING.rst
+96
-0
96 additions, 0 deletions
CONTRIBUTING.rst
README.rst
+6
-0
6 additions, 0 deletions
README.rst
with
102 additions
and
0 deletions
CONTRIBUTING.rst
0 → 100644
+
96
−
0
View file @
088315eb
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
This diff is collapsed.
Click to expand it.
README.rst
+
6
−
0
View file @
088315eb
=========
Hypertool
=========
Contribution
============
Please follow the `Contribution Guidelines <CONTRIBUTING.rst>`_ to get started.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment