Skip to content

Add AGENTS.md guidance for coding agents - #3099

Open
antonwolfy wants to merge 5 commits into
masterfrom
add-agents-md
Open

antonwolfy wants to merge 5 commits into
masterfrom
add-agents-md

Conversation

@antonwolfy

@antonwolfy antonwolfy commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

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 reads AGENTS.md only when there is no CLAUDE.md, .claude/CLAUDE.md or CLAUDE.local.md on the path, so the repository should not gain a CLAUDE.md. Contributors who keep a personal CLAUDE.local.md need to set "Project instructions" to claude-md-and-agents-md.
  • GitHub Copilot gives the nearest AGENTS.md precedence, so review-critical rules are kept in the root file.

Checklist:

  • Have you provided a meaningful PR description?
  • Have you added a test, reproducer or referred to an issue with a reproducer?
  • Have you tested your changes locally for CPU and GPU devices?
  • Have you made sure that new changes do not introduce compiler warnings?
  • Have you checked performance impact of proposed changes?
  • Have you added documentation for your changes, if necessary?
  • Have you added your changes to the changelog?

Add a root AGENTS.md and per-directory guides for dpnp/, dpnp/tests/,
dpnp/backend/, dpnp/tensor/, doc/, benchmarks/ and .github/.

The rules come from recurring maintainer review comments, and every
command, path and identifier in them is checked against the tree.
@github-actions

Copy link
Copy Markdown
Contributor

View rendered docs @ https://intelpython.github.io/dpnp/pull/3099/index.html

@github-actions

github-actions Bot commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Array API standard conformance tests for dpnp=0.21.0dev14=np2py314h8d9cdd5_10 ran successfully.
Passed: 1376
Failed: 0
Skipped: 6

-m "slow or not slow" now runs slow tests, "0" disables the test env
flags, and large-allocation tests skip on USMAllocationError.
@antonwolfy antonwolfy added this to the 0.21.0 release milestone Oct 14, 2026
@coveralls

coveralls commented Oct 14, 2026 •

Copy link
Copy Markdown
Collaborator

Coverage Status

coverage: 82.61%. remained the same — add-agents-md into master

antonwolfy and others added 3 commits October 15, 2026 12:33
doc/docstring_template.py is current again, dpnp/tensor no longer
mentions dpctl.tensor, and placeholder pages are marked :orphan:.
New extensions call build_dpnp_pybind11_ext instead of copying an
existing CMakeLists.txt, and request -fno-sycl-id-queries-fit-in-int
with its LARGE_RANGES option.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants