Skip to content

Commit f496cd1

Browse files
authored
Add top-level testing instructions (#725)
* Add top-level testing instructions * Update AGENTS testing guidance * Update AGENTS after rerunning Python tests * Update AGENTS.md
1 parent 6b385d6 commit f496cd1

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

AGENTS.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Repository Instructions
2+
3+
## Running tests
4+
- **Julia tests**: Run from the project root with `julia --project -e 'using Pkg; Pkg.test()'`. Expect a warning about the General registry being unreachable in locked-down environments; the suite still finishes (PyCall tests are marked broken/Skipped).
5+
- **Python tests**:
6+
- Copy `pysrc/juliacall/juliapkg-dev.json` to `pysrc/juliacall/juliapkg.json` before running (do **not** commit this copy).
7+
- Execute with `uv run pytest -s --nbval ./pytest` (add `--cov=pysrc` when coverage is needed).
8+
- Sometimes `juliapkg` requires Julia 1.10–1.11; `juliaup` already provides 1.11.7 in this environment.
9+
10+
The majority of tests live in the Julia package; Python tests cover functionality that cannot be exercised from Julia (e.g., JuliaCall-specific behavior). Run both suites—typically Julia first—in whichever order makes sense.
11+
12+
## Meta instructions
13+
- When you discover environment quirks, false assumptions, process fixes, or any other generally useful info, update this AGENTS.md so future coding agents have the information.

0 commit comments

Comments
 (0)