IntelPython / dpnp / 41033628467

83%

push

github

Add AGENTS.md guidance for coding agents (#3099)

This PR adds `AGENTS.md` files with guidance for AI coding agents
working on dpnp: a root file plus one per area (`dpnp/`, `dpnp/tests/`,
`dpnp/backend/`, `dpnp/tensor/`, `doc/`, `benchmarks/`, `.github/`).

It supersedes #2775. The `.github/copilot-instructions.md` and
`.github/instructions/*` files proposed there are not added, because
Copilot reads `AGENTS.md` and they would only duplicate it.

How the content was built:
- **Rules from review history.** The rules come from recurring human
review comments on about 540 recent PRs, keeping themes raised in at
least 3 PRs: changelog entries, devices without fp64 support, compute
follows data, hidden host transfers, docstring house style, CuPy tests
mirroring upstream, short comments, and more.
- **Every claim checked against the tree.** Commands, paths, identifiers
and conventions were verified against the repository, since an agent
follows them literally. No line numbers are used, so the files don't go
stale with every edit.
- **Rules first, generic advice left out.** The root file starts with
the rules and the verification commands, plus a table of which CI checks
are required on master. Each nested file only adds what is specific to
its directory.

The files are plain `AGENTS.md`, which Claude Code, GitHub Copilot,
Codex and Cursor read natively, including nested files, so no
tool-specific copies are added.

Known gaps:
- Gemini CLI reads only `GEMINI.md` unless `context.fileName` in its
settings includes `AGENTS.md`.
- Claude Code (v2.1.277 or later) reads `AGENTS.md` only when there is
no project `CLAUDE.md`, `.claude/CLAUDE.md` or `CLAUDE.local.md` in the
working directory or above it, and skips a nested `AGENTS.md` whose own
directory has one. So the repository should not gain a `CLAUDE.md`. A
personal `~/.claude/CLAUDE.md` or a managed `CLAUDE.md` doesn't count
and loads alongside `AGENTS.md`. Contributors who keep a
`CLAUDE.local.md` need to se... (continued)

1604 of 2994 branches covered (53.57%)

Branch coverage included in aggregate %.

29435 of 34567 relevant lines covered (85.15%)

17672.44 hits per line