-
Notifications
You must be signed in to change notification settings - Fork 32
Introducing AGENTS.md #2233
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Introducing AGENTS.md #2233
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR introduces comprehensive AI agent documentation (AGENTS.md files) across the dpctl repository to guide AI assistants in understanding the codebase structure, conventions, and patterns. It also adds corresponding GitHub Copilot instruction files to enforce these patterns during code review and generation.
Changes:
- Added AGENTS.md files documenting architecture, patterns, and conventions for each major component (core bindings, tensor operations, C++ kernels, memory management, testing, and C API layer)
- Created GitHub-specific instruction files that reference the AGENTS.md documentation for automated code review guidance
- Established a root-level AGENTS.md that provides project overview and links to component-specific documentation
Reviewed changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| AGENTS.md | Root documentation providing project overview, architecture diagram, and directory guide |
| dpctl/AGENTS.md | Documentation for core SYCL bindings covering Cython conventions and extension type patterns |
| dpctl/tensor/AGENTS.md | Guide for Array API tensor operations and elementwise wrapper patterns |
| dpctl/tensor/libtensor/AGENTS.md | Documentation for C++ SYCL kernel implementations including functor and factory patterns |
| dpctl/memory/AGENTS.md | USM memory management documentation covering memory types and lifetime rules |
| dpctl/program/AGENTS.md | SYCL kernel compilation documentation and usage patterns |
| dpctl/utils/AGENTS.md | Utility functions documentation focusing on queue validation |
| dpctl/tests/AGENTS.md | Test suite patterns and coverage requirements |
| libsyclinterface/AGENTS.md | C API layer documentation covering naming conventions and memory ownership |
| .github/instructions/*.instructions.md | GitHub Copilot instruction files referencing AGENTS.md for each component |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@napetrov
In general, the examples seem to lean towards being less verbose about the code itself, and focus more directly on agent behavior/instructions I will need to test this locally with a few examples, like what's laid out in the SciPy discussion |
This PR introducing initial version of AGENTS.md and instructions for copilot