diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..c0236dc0 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,31 @@ +# AGENTS.md + +Guidelines for AI agents working in this repository. + +## Commands + +All commands are executed via `make`. + +```bash +make [VARIABLE=value ...] +``` + +### Variables + +| Variable | Description | +|---|---| +| `NO_TTY=1` | **Always pass this** — there is no interactive terminal | +| `ARGS="..."` | Extra arguments passed to the underlying tool | +| `PHP_VERSION=8.3` | Override PHP version (default: 8.4) | + +### Targets + +| Target | Description | +|---|---| +| `make test` | Run PHPUnit tests (alias for `make phpunit`) | +| `make phpunit` | Run PHPUnit tests | +| `make coverage` | Generate HTML coverage report to `runtime/coverage/` | +| `make infection` | Run mutation testing with Infection (alias: `make mutation`) | +| `make psalm` | Run Psalm static analysis | +| `make php-cs-fixer` | Fix code style with PHP-CS-Fixer (alias: `make cs-fix`) | +| `make composer` | Run Composer | diff --git a/Makefile b/Makefile index 43ed8e66..12df1e47 100644 --- a/Makefile +++ b/Makefile @@ -3,7 +3,7 @@ PHP_VERSION ?= 8.4 -include .env.local -DOCKER_RUN := docker run --rm -it \ +DOCKER_RUN := docker run --rm $(if $(NO_TTY),,-it) \ --init \ --user $(shell id -u):$(shell id -g) \ --env YII_INSIDE_CONTAINER=true \