Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1.95 KB

File metadata and controls

41 lines (29 loc) · 1.95 KB

Extending Agent Coding Guidance

ONNX Runtime uses layered agent customizations so that guidance is available to GitHub Copilot and local agents without duplicating subsystem knowledge. This document explains how maintainers should extend that system.

Guidance Layers

Location Purpose
AGENTS.md Repository-wide guidance.
.github/instructions/ Guidance for working with specific paths.
.github/skills/code-review/SKILL.md Generic code review workflow.
.github/skills/ Deeper workflows and knowledge for particular tasks or subsystems.

Keep each piece of guidance in one canonical location. Other layers should point to it rather than restating it.

Keep .github/copilot-instructions.md minimal. It should route GitHub Copilot to canonical guidance in AGENTS.md rather than contain guidance that other agents cannot discover.

Adding Path-Scoped Instructions

Create a descriptively named *.instructions.md file under .github/instructions/. Include YAML frontmatter with a meaningful description and an applyTo string. Separate multiple patterns with commas.

---
description: "Guidance for Example subsystem changes."
applyTo: "onnxruntime/core/example/**/*.cc,onnxruntime/core/example/**/*.h"
---

# Example Subsystem

State the invariant, why it matters when that is not obvious, and what a correct change must update.

Use the narrowest paths that reliably identify relevant changes. Avoid applyTo: "**"; repository-wide guidance belongs in AGENTS.md. Unless the text explicitly limits their scope, matching instructions apply to both implementation and review.

Prefer actionable invariants over broad reminders. Good guidance identifies a concrete failure mode and the required correction. Link to existing design documentation or domain skills for detailed background instead of copying it.