Contributing to pgeon / pgeon-xai

First off, thank you for considering contributing to pgeon! We welcome any contributions that help improve the project.

Getting Started

To get your development environment set up, please follow these steps:

Clone your fork locally:

git clone https://github.com/HPAI-BSC/pgeon.git

Change into the repository directory:
```
cd pgeon
```
Create and sync a virtual environment: We recommend using uv:
```
uv sync --locked
```
Install pre-commit hooks: This helps ensure code style and quality consistency.
```
uv run pre-commit install
```

Create a new branch for your feature or bug fix:
```
git checkout -b your-branch-name
```
Make your changes: Write your code and add tests if applicable.
Run tests: Ensure all tests pass.
```
uv run python -m unittest discover
```
Commit your changes: Use clear and descriptive commit messages. Pre-commit hooks will run automatically.
```
git add .
git commit -m "feat: Describe your feature or fix"
```
Push your branch to your fork:
```
git push origin your-branch-name
```
Open a Pull Request (PR) against the main branch of the original HPAI-BSC/pgeon repository. Provide a clear description of your changes in the PR.

Please use the GitHub Issues page to report bugs or request new features. Provide as much detail as possible.

Thank you for contributing!