Skip to content

Adding agent files for oneDPL - #2668

Open
danhoeflinger wants to merge 11 commits into
mainfrom
dev/dhoeflin/agent_files
Open

danhoeflinger wants to merge 11 commits into
mainfrom
dev/dhoeflin/agent_files

Conversation

@danhoeflinger

@danhoeflinger danhoeflinger commented Apr 21, 2026 •

Copy link
Copy Markdown
Contributor

I have been using these agent files for some time now locally.
The goal is to provide AI agents better context with which to navigate the repository intelligently.

We use AGENTS.md so that it is generic across all major providers, and symlinks (@) for CLAUDE.md and GEMINI.md. Gemini gets some extra guidance to resolve some recuring issues.
We keep AGENTS.md small so that we don't bloat or confuse the context too much.

We also provide and link to a more verbose description of the code layout in IMPLEMENTATION_DETAILS.md so it is only read into the context when needed.

I'm open to other configurations, perhaps refactoring IMPLEMENTATION_DETAILS.md into our main docs as a section and linking to it there, but I'd like to open it up for input from others.

Signed-off-by: Dan Hoeflinger <dan.hoeflinger@intel.com>
Signed-off-by: Dan Hoeflinger <dan.hoeflinger@intel.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds repository “agent guidance” documentation intended to help AI assistants navigate and work in the oneDPL codebase more effectively, with a concise entrypoint (AGENTS.md) and a more detailed architecture reference (IMPLEMENTATION_DETAILS.md), plus provider-specific entry files.

Changes:

  • Added AGENTS.md with build/test, architecture, and contribution pointers for AI agents.
  • Added IMPLEMENTATION_DETAILS.md describing oneDPL’s layering, backend structure, and test layout.
  • Added CLAUDE.md and GEMINI.md as thin entry files referencing AGENTS.md (with extra Gemini-specific guidance).

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 8 comments.

File Description
AGENTS.md New agent-facing quick reference for building/testing, architecture, and repo conventions
IMPLEMENTATION_DETAILS.md New detailed architecture/development-pattern overview for deeper context
CLAUDE.md Provider-specific entry file referencing AGENTS.md
GEMINI.md Provider-specific entry file referencing AGENTS.md, with additional workflow guidance

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread IMPLEMENTATION_DETAILS.md Outdated
Comment thread IMPLEMENTATION_DETAILS.md
Comment thread IMPLEMENTATION_DETAILS.md
Comment thread IMPLEMENTATION_DETAILS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md
Comment thread AGENTS.md Outdated
danhoeflinger and others added 5 commits April 21, 2026 13:59
Signed-off-by: Dan Hoeflinger <dan.hoeflinger@intel.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Dan Hoeflinger <dan.hoeflinger@intel.com>
Signed-off-by: Dan Hoeflinger <dan.hoeflinger@intel.com>
Signed-off-by: Dan Hoeflinger <dan.hoeflinger@intel.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread AGENTS.md
Comment thread AGENTS.md
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md
Comment thread AGENTS.md
Comment thread AGENTS.md
- **Header-only library** - no binary artifacts
- **C++17 minimum** required
- **Backend selection is compile-time only** - zero runtime overhead
- **Two-phase headers** - `*_defs.h` (declarations), `*_impl.h` (implementations)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want a requirement specifying that all AI-authored commits should be disclosed in the commit message? I think if we list it here, the agent should respect it.

It brings up another question about if we should adjust the contribution guide to give user guidance for AI generated code (e.g. all commit should be human reviewed prior to opening a PR, but I think that can be addressed separately).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Its a good question. I think ultimately the committing user has to be responsible for the code whether or not it was partially or fully generated by an agent. In this case, I'm not so sure that adding something to the commit message is important, but its worth discussing and perhaps making a policy.

Signed-off-by: Dan Hoeflinger <dan.hoeflinger@intel.com>
Comment thread AGENTS.md
Signed-off-by: Dan Hoeflinger <dan.hoeflinger@intel.com>
Comment thread AGENTS.md
Co-authored-by: Matthew Michel <matthew.michel@intel.com>
Comment thread AGENTS.md Outdated
Signed-off-by: Dan Hoeflinger <dan.hoeflinger@intel.com>

This branch has not been deployed

No deployments
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.

5 participants