maint: add agents

Author: Steven Murray

agents.md

@@ -0,0 +1,76 @@
+# AGENTS.md
+
+## Do
+- use uv run for all project tooling commands (pytest, ruff, etc.)
+- setup environment with uv sync; prefer uv sync --locked --all-extras --dev for CI parity
+- add type hints for all new parameters
+- write or update tests for every behavior change
+- add numpydoc-style docstrings for new public modules, classes, and functions
+- update docstrings whenever parameters are added or changed
+- prefer minimal, file-scoped checks before broad checks
+
+## Do not
+- do not edit CHANGELOG.rst unless explicitly asked
+- do not modify regression artifacts or data snapshots unless explicitly asked
+- do not run full test suites or expensive notebook/doc executions without approval
+- do not introduce API-breaking renames or default changes without explicit confirmation
+
+### Commands
+
+#### File-scoped quality checks (preferred)
+uv run ruff format path/to/file.py
+uv run ruff check --fix path/to/file.py
+
+#### Targeted tests (preferred)
+uv run pytest tests/path/to/test_file.py
+uv run pytest tests/path/to/test_file.py -k keyword
+
+#### Wider checks (ask first)
+uv run prek run -a
+uv run pytest
+
+### Safety and permissions
+
+Allowed without prompt:
+- read, list, and search files
+- edit source, tests, and docs text files relevant to the task
+- run file-scoped ruff checks
+- run one or a few targeted pytest files
+
+Ask first:
+- package or environment installs/upgrades
+- full-suite pytest runs
+- notebook execution across docs/examples
+- regenerating regression data
+- deleting files, chmod, git push
+
+### Testing expectations
+
+- bug fixes should include regression tests
+- use explicit numeric tolerances for floating-point comparisons
+- handle warnings intentionally (fix or filter in tests)
+
+### API docs
+
+- docs are built with sphinx and numpydoc
+- keep API docs indexed in docs/api.rst when adding new public objects
+
+### Process note
+
+- branch/release docs and workflows may differ historically; do not assume release branching strategy unless user specifies
+
+### PR checklist
+
+- formatting and lint checks pass
+- unit tests pass
+- tests added for new or changed behavior
+
+### When stuck
+
+- ask a clarifying question
+- propose a short plan with assumptions
+- provide a minimal draft patch with explicit unknowns
+
+### Test-first mode
+
+- for new features, write or update tests first, then code to green

pyproject.toml

@@ -73,7 +73,7 @@ tests = [
 dev = [
     {include-group = "docs"},
     {include-group = "tests"},
-    "pre-commit>=4.5.1",
+    "prek>=0.3.8",
     "ruff>=0.15.6",
 ]