# AGENTS.md

DSPy: The framework for programming—not prompting—language models

## Setup

```
uv sync
```

## Commands

```
pytest         # run the test suite
ruff check .   # lint
```

## Layout

- `dspy/`  157 source files
- `tests/` 117 source files
- `docs/`  8 source files

## Conventions

- Tests live alongside the code they cover, following `.github/workflows/build_utils/test_version.py`.
- CI defines what passing means. See `.github/workflows/build_and_release.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `tests/adapters/test_chat_adapter.py` is 117KB. It will not fit comfortably in context, so read it in parts.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.