# AGENTS.md

OpenAssistant is a chat-based assistant that understands tasks, can interact with third-party systems, and retrieve information dynamically to do so.

## Setup

```
# TODO: the install command. No lockfile was found, so this could not be inferred.
```

## Commands

```
ruff check .   # lint
```

## Layout

- `website/`      335 source files
- `backend/`      122 source files
- `inference/`    71 source files
- `model/`        69 source files
- `data/`         51 source files
- `discord-bots/` 48 source files

## Conventions

- Tests live alongside the code they cover, following `backend/tests/__init__.py`.
- CI defines what passing means. See `.github/workflows/build-frontend.yaml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `data/datasets/safety_directory/child_help/child_help.py` is 155KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

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.