Skip to content

Add AGENTS.md and GitHub Copilot instructions#91

Open
napetrov wants to merge 1 commit intomasterfrom
add-agents-instructions
Open

Add AGENTS.md and GitHub Copilot instructions#91
napetrov wants to merge 1 commit intomasterfrom
add-agents-instructions

Conversation

@napetrov
Copy link

What

Add structured AI agent instructions following Intel's AGENTS spec v4:

  • AGENTS.md — project context for agents (RNG interface, archetype, structure, source-of-truth mapping)
  • .github/copilot-instructions.md — agent behavior policy (precedence, contribution expectations, Intel-specific constraints)

Why

Standardizes how AI coding assistants (GitHub Copilot, Claude, etc.) understand and work with this repo, reducing hallucinations and enforcing Intel engineering standards automatically.

Key guidance added

  • Preserve numpy.random API compatibility by default
  • RNG specifics: BRNG selection and distribution methods must preserve statistical properties
  • Release GIL (with nogil:) for MKL RNG calls (thread-safe in MKL)
  • No hardcoded versions, flags, or BRNG names outside __init__.py
  • Statistical validation required for RNG changes
  • Local dev: conda create -n dev python numpy cython mkl-devel pytest && pip install -e .

Token budget

  • AGENTS.md: 217 words (limit 220)
  • Based on mkl_fft pattern

Checklist

  • AGENTS.md exists at repo root
  • .github/copilot-instructions.md exists
  • Required headings present
  • No placeholder text
  • No mutable details hardcoded
  • Precedence hierarchy documented
  • Word count within limits

Introduce structured AI agent instructions following Intel's AGENTS spec v4:

- AGENTS.md: project context (RNG interface, archetype, structure, source-of-truth)
- .github/copilot-instructions.md: agent behavior policy

Key guidance:
- Preserve numpy.random API compatibility
- RNG specifics: BRNG selection, statistical properties
- Cython: release GIL for MKL RNG calls (thread-safe)
- Local dev: conda env + pip install -e .
- Statistical validation required for RNG changes

Token budget: 217 words (AGENTS.md) + copilot-instructions
Based on mkl_fft pattern
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.

1 participant

Comments