chore: add AGENTS.md and CLAUDE.md (#10884)

* chore: add AGENTS.md and CLAUDE.md

* draft

* better Hatch
This commit is contained in:
Stefano Fiorucci
2026-03-20 11:48:41 +01:00
committed by GitHub
parent 7b40f9807d
commit 0defe99687
3 changed files with 62 additions and 2 deletions
-2
View File
@@ -176,5 +176,3 @@ haystack/json-schemas
# uv
uv.lock
CLAUDE.md
+59
View File
@@ -0,0 +1,59 @@
# Haystack Guidelines for AI Agents
## Environment
Haystack uses **Hatch** for environment and dependency management.
Do not run `python` or `pip` directly.
Before running code on this project, you must be able to run `hatch --version` and get a correct output.
If not, ask the user where Hatch is or if they want to install it. For installation instructions, refer to https://hatch.pypa.io/latest/install/#installation.
### Run scripts with test dependencies
hatch -e test run python SCRIPT.py
### Open a shell with test dependencies
hatch -e test shell
### Install temporary dependencies (for experiments only)
uv pip install PACKAGE
### Delete the environment
hatch env prune
## Tests
Tests run via Hatch and support pytest arguments.
Prefer running tests on a specific module or using `-k`, since the full suite is large.
### Run unit tests
hatch run test:unit
### Run integration tests
hatch run test:integration
## Quality Checks
### Type checking with mypy
hatch run test:types
To fix type issues, avoid `type: ignore`, casts, or assertions when possible. If they are necessary, explain why.
### Format and lint
hatch run fmt
## Release Notes
Every user-facing PR (not docs, not CI) must include a release note:
hatch run release-note SHORT_DESCRIPTION
Edit the generated file in `releasenotes/notes/`.
+3
View File
@@ -0,0 +1,3 @@
# CLAUDE.md
Before you start working on this repository, read the AGENTS.md file and follow all the instructions.