Contributing to ai-commit

Thank you for your interest in contributing! We welcome bug reports, feature requests, and pull requests.

Development Setup

Clone the repository:

git clone https://github.com/Slightly-Techie/ai-commit
cd ai-commit

Create and activate a virtual environment:

python -m venv .venv
source .venv/bin/activate
# On Windows, use: .venv\Scripts\activate

Install dependencies in editable mode: We use uv (or pip) for dependency management. This command installs the project itself and all development tools like pytest and ruff.
```
pip install uv
uv pip install -e '.[dev]'
```

We follow a strict Test-Driven Development (TDD) workflow. All code must pass linting and testing checks.

Run the test suite: This includes unit and integration tests.
```
pytest
```

Check for at least 90% test coverage:

pytest --cov=ai_commit --cov-fail-under=80

Run the linter: We use ruff for linting and code style enforcement.
```
ruff check .
```