code_en.md

Developer Guide

This document describes how to develop and contribute code to this repository. The project uses uv to manage a project-local .venv and provides a Makefile with common formatting, linting and testing commands.

Contribution Workflow

• Except for maintainers, please follow the fork and pull request workflow.
• Fill in the Pull Request template before submitting.
• Continuous integration will run lint and tests automatically. Make sure all checks pass locally.
• When adding features or fixing bugs, update the documentation accordingly and add tests in tests/unit_tests or tests/integration_tests whenever possible.

Dependency Installation

The project dependencies are managed with uv. uv creates a project-local .venv in the repository root, so a global or Conda environment is not required. Install uv first:

curl -LsSf https://astral.sh/uv/install.sh | sh

Then install all development dependencies from the repository root:

uv sync --all-groups

If you only need to run AnnaAgent without development tools, use:

uv sync

Common Development Commands

The repository provides a Makefile to easily run common tasks. All commands are executed from the project root.

Code Formatting

Use ruff to format the code:

make format

Linting

Run static and import checks:

make lint

Unit Tests

Run the unit tests:

make test

Integration Tests

Run the integration tests:

make integration_tests

Coverage Report

Generate a coverage report:

make coverage

Run make help for more commands.