Skip to content

Commit 6f339f9

Browse files
committed
docs: address review feedback (clarify entry point, NumPy focus, path resolution)
1 parent 24cef9f commit 6f339f9

File tree

4 files changed

+16
-8
lines changed

4 files changed

+16
-8
lines changed

.github/copilot-instructions.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,18 @@
33
## Source of truth
44
This file is canonical for Copilot behavior in this repository.
55

6-
`AGENTS.md` files provide directory scope/guardrails for AGENTS-aware tools and should not duplicate Copilot policy text.
6+
For project context and directory routing, read root `AGENTS.md` first.
7+
8+
`AGENTS.md` files provide directory scope/guardrails and should not duplicate Copilot policy text.
79

810
## Mandatory flow
9-
Read root `AGENTS.md`, then nearest local `AGENTS.md` for edited files; most specific wins.
11+
1. Read root `AGENTS.md`.
12+
2. Read nearest local `AGENTS.md` for edited files.
13+
3. Most specific AGENTS wins when multiple apply.
1014

1115
## Contribution expectations
1216
- Keep diffs minimal and scoped to the task.
13-
- Preserve API behavior by default.
17+
- Preserve NumPy-compatible API behavior by default.
1418
- For behavior/API changes: update tests, and docs/examples when user-visible.
1519
- For bug fixes: prefer adding regression coverage.
1620

@@ -19,6 +23,7 @@ Read root `AGENTS.md`, then nearest local `AGENTS.md` for edited files; most spe
1923
- Do not invent or hardcode versions, flags, or matrix values.
2024

2125
## Source-of-truth files
26+
All paths relative to project root:
2227
- Build/config: `CMakeLists.txt`, `pyproject.toml`, `setup.py`, `setup.cfg`
2328
- CI/checks: `.github/workflows/`
2429
- Style/lint: `.pre-commit-config.yaml`, `.clang-format`, `.flake8`

.github/instructions/build.instructions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ applyTo: "{CMakeLists.txt,pyproject.toml,setup.py,setup.cfg,**/CMakeLists.txt}"
44

55
# Build Instructions for GitHub Copilot
66

7+
All paths below are relative to project root.
8+
79
- Reuse existing build/config patterns.
810
- Keep mutable build details in source-of-truth files.
911
- Avoid introducing parallel build paths unless requested.

AGENTS.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,23 @@
11
# AGENTS.md
22

3-
This file is for AGENTS-aware tools.
3+
Entry point for agent context in this repo.
44

55
## What this repository is
66
`dpnp` is the Data Parallel Extension for NumPy: a NumPy-compatible Python API with accelerated execution backends and cross-platform packaging/CI.
77

88
## How to work in this repo
99
- 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.
10+
- Preserve NumPy-compatible API behavior by default; call out intentional behavior changes in PR text.
1111
- Pair user-visible changes with tests and docs/examples updates.
1212
- Avoid duplicating mutable details (versions/flags/matrix) in instruction docs.
1313

1414
For Copilot behavior policy (flow, source-of-truth, edit hygiene), see:
1515
- `.github/copilot-instructions.md` (canonical for Copilot behavior)
1616

1717
## Directory map
18+
Below directories have local `AGENTS.md` for deeper context:
1819
- `.github/AGENTS.md` — CI/workflow/automation context
19-
- `dpnp/AGENTS.md` — core implementation behavior guardrails
20+
- `dpnp/AGENTS.md` — core NumPy-compatible implementation guardrails
2021
- `doc/AGENTS.md` — documentation updates and consistency
2122
- `examples/AGENTS.md` — runnable user-facing examples
2223
- `benchmarks/AGENTS.md` — reproducible performance evaluation

dpnp/AGENTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# AGENTS.md — dpnp/
22

3-
Core package implementation and Python/Cython-facing behavior.
3+
Core NumPy-compatible package implementation and Python/Cython-facing behavior.
44

5-
- Preserve API behavior and compatibility by default.
5+
- Preserve NumPy API compatibility by default.
66
- Keep dtype/shape/error behavior explicit.
77
- For test policy, follow `.github/instructions/testing.instructions.md`.

0 commit comments

Comments
 (0)