Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates AGENTS.md to provide more onboarding guidance for building, extending (ops/kernels), and navigating ONNX Runtime documentation and tooling.
Changes:
- Add a “Build prerequisites” section with baseline toolchain requirements.
- Add high-level guidance for adding operators/kernels, EP responsibilities, and test directory layout.
- Add tables for tool configuration and key documentation links.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
sharing a local Copilot's opinion: do the changes make it easier for you to perform tasks in the repo? Yes, meaningfully so. Here's a concrete breakdown of what helps and what's less impactful: High value: Test organization table — This is probably the single most useful addition. When asked to write or find tests, knowing providers/ has per-EP kernel tests vs. contrib_ops/ has contrib op tests vs. shared_lib/ has C API tests saves me multiple search steps. Moderate value: Tool Configuration table — Knowing that lintrunner -a auto-fixes and which config files control which tools helps me when asked to lint or format. Though the /ort-lint skill already covers this in more detail. Lower value (for an agent): Build prerequisites — I can discover CMake version requirements from CMakeLists.txt and Python version from setup.py. This section is more useful for human onboarding. That said, it does prevent me from giving wrong advice about minimum versions (assuming the Python version issue gets fixed). What would help even more: Guidance on which build preset/configuration to use for quick local iteration (e.g., minimal CPU-only debug build). The /ort-build skill likely covers this, but a quick pointer in AGENTS.md would help. So net: the changes reduce the number of exploratory searches I need to do by ~30-40% for common tasks like "add a kernel," "find the right test directory," or "which doc covers X." That's a real improvement. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Description
Purported improvments.
Motivation and Context
Share. Share.