Contribution Guide¶

Thank you for your interest in contributing to our project! Please follow these guidelines to ensure a smooth contribution process.

Prerequisites¶

Python 3.10 or higher
Git
uv (recommended) or pip

Setting Up the Development Environment¶

Clone the repository:

git clone https://github.com/semohr/eyconf.git
cd eyconf

Install the dependencies with uv:

# Install with development dependencies
uv sync --all-extras

# Or if you prefer pip:
pip install -e .[dev]

Activate environemnt (if uv):
```
source .venv/env/activate
```

Install pre-commit hooks¶

We automatically check for code style and formatting issues using pre-commit hooks. To install the hooks, run the following command:

pre-commit install

Before Submitting a Pull Request¶

Verify that your code follows the project’s coding standards and conventions. Run Ruff manually or use the pre-commit hooks to check for any issues. Additionally, run the tests to ensure that your changes do not break any existing functionality.

# Run Ruff manually
ruff check
# Run the tests
pytest
# Run type checking
pyrefly check

Docs¶

To build the documentation locally, run:

cd docs
make html