# Contributing to aviary

## Repo Structure

aviary is a monorepo using [`uv`'s workspace layout](https://docs.astral.sh/uv/concepts/workspaces/#workspace-layouts).

## Installation

1. Git clone this repo
2. Install the project manager `uv`: <https://docs.astral.sh/uv/getting-started/installation/>
3. Run `uv sync`

This will editably install the full monorepo in your local environment.

## Testing

To run tests, please just run `pytest` in the repo root.

Note you will need OpenAI and Anthropic API keys configured.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.edisonscientific.com/aviary/contributing.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.