|
2 | 2 |
|
3 | 3 | This file is for AGENTS-aware tools. |
4 | 4 |
|
5 | | -Scope: |
6 | | -- Repository context for AGENTS-aware agents. |
7 | | -- Directory routing to local AGENTS files. |
| 5 | +## What this repository is |
| 6 | +`dpnp` is the Data Parallel Extension for NumPy: a NumPy-compatible Python API with accelerated execution backends and cross-platform packaging/CI. |
8 | 7 |
|
9 | | -For Copilot policy (flow, source-of-truth, edit hygiene), see: |
| 8 | +## How to work in this repo |
| 9 | +- Keep changes small and single-purpose (bug fix, perf, docs, or infra). |
| 10 | +- Preserve API behavior by default; call out intentional behavior changes in PR text. |
| 11 | +- Pair user-visible changes with tests and docs/examples updates. |
| 12 | +- Avoid duplicating mutable details (versions/flags/matrix) in instruction docs. |
| 13 | + |
| 14 | +For Copilot behavior policy (flow, source-of-truth, edit hygiene), see: |
10 | 15 | - `.github/copilot-instructions.md` (canonical for Copilot behavior) |
11 | 16 |
|
12 | | -Directory map: |
13 | | -- `.github/AGENTS.md` |
14 | | -- `dpnp/AGENTS.md` |
15 | | -- `doc/AGENTS.md` |
16 | | -- `examples/AGENTS.md` |
17 | | -- `benchmarks/AGENTS.md` |
18 | | -- `scripts/AGENTS.md` |
19 | | -- `tests_external/AGENTS.md` |
| 17 | +## Directory map |
| 18 | +- `.github/AGENTS.md` — CI/workflow/automation context |
| 19 | +- `dpnp/AGENTS.md` — core implementation behavior guardrails |
| 20 | +- `doc/AGENTS.md` — documentation updates and consistency |
| 21 | +- `examples/AGENTS.md` — runnable user-facing examples |
| 22 | +- `benchmarks/AGENTS.md` — reproducible performance evaluation |
| 23 | +- `scripts/AGENTS.md` — maintenance/developer scripts |
| 24 | +- `tests_external/AGENTS.md` — external/integration validation scope |
0 commit comments