Skip to content

Conversation

@napetrov
Copy link

This PR introducing initial version of AGENTS.md and instructions for copilot

  • Have you provided a meaningful PR description?
  • Have you added your changes to the changelog?
  • If this PR is a work in progress, are you opening the PR as a draft?

@coveralls
Copy link
Collaborator

Coverage Status

coverage: 86.248%. remained the same
when pulling a4d95a0 on napetrov:dev/napetrov_agents
into ce41a87 on IntelPython:master.

@napetrov napetrov marked this pull request as ready for review February 2, 2026 05:51
@napetrov napetrov requested a review from Copilot February 2, 2026 05:51
Copy link

Copilot AI left a 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.

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.

2 participants