Skip to content

Commit 24cef9f

Browse files
committed
docs: expand repo/workflow guidance in agent instructions
1 parent b01c43d commit 24cef9f

File tree

2 files changed

+24
-15
lines changed

2 files changed

+24
-15
lines changed

.github/copilot-instructions.md

Lines changed: 7 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
7-
should not duplicate Copilot policy text.
6+
`AGENTS.md` files provide directory scope/guardrails for AGENTS-aware tools and should not duplicate Copilot policy text.
87

98
## Mandatory flow
109
Read root `AGENTS.md`, then nearest local `AGENTS.md` for edited files; most specific wins.
1110

11+
## Contribution expectations
12+
- Keep diffs minimal and scoped to the task.
13+
- Preserve API behavior by default.
14+
- For behavior/API changes: update tests, and docs/examples when user-visible.
15+
- For bug fixes: prefer adding regression coverage.
16+
1217
## Authoring rules
13-
- Keep suggestions minimal and scoped.
1418
- Use source-of-truth files for mutable details.
1519
- Do not invent or hardcode versions, flags, or matrix values.
1620

AGENTS.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,23 @@
22

33
This file is for AGENTS-aware tools.
44

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.
87

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:
1015
- `.github/copilot-instructions.md` (canonical for Copilot behavior)
1116

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

Comments
 (0)