Skip to content

docs(hipfile): Add AGENTS.md for AI coding agents - #13875

Merged
derobins merged 1 commit into
developfrom
derobins/hipfile_agents_md
Oct 21, 2026
Merged

derobins merged 1 commit into
developfrom
derobins/hipfile_agents_md

Conversation

@derobins

@derobins derobins commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

Motivation

Agents need guidance when working in hipFile.

Technical Details

Add an AGENTS.md, adapted from hipObject's, that gives AI coding agents hipFile's build, test, API, and linting rules and the constraints that come from building in TheRock. Rules the existing code doesn't pass yet are marked advisory until it does. CLAUDE.md now just includes AGENTS.md.

Issue Tracking

JIRA ID: ROCM-28534

Test Plan

Codespell passes

Test Result

Success

Submission Checklist

Add an AGENTS.md, adapted from hipObject's, that gives AI coding agents
hipFile's build, test, API, and linting rules and the constraints that
come from building in TheRock. Rules the existing code doesn't pass yet
are marked advisory until it does. CLAUDE.md now just includes AGENTS.md.

Co-Authored-By: Claude <noreply@anthropic.com>
@derobins
derobins requested a review from a team as a code owner October 21, 2026 01:25
Copilot AI balanced review requested due to automatic review settings October 21, 2026 01:25
@therock-pr-bot

Copy link
Copy Markdown

✅ All Policy Checks Passed

Check Status Details
📝 PR Description ✅ Pass —
⛔ Forbidden Files ✅ Pass —
🧪 Unit Test ✅ Pass PR does not contain code files — Unit Test auto-passed
🚫 Draft PR 🔜 To Be Enabled —
🚩 Feature Flag 🔜 To Be Enabled —
📊 Code Coverage 🔜 To Be Enabled —

🎉 All policy checks passed!

📖 Need help? See the Policy FAQ for details on every check and how to fix failures.

🙋 Wish to Override Policy?

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.

🟢 Approval recommended

The documentation-only change has minor accuracy corrections but no blocking code or operational issues.

3 open issues
What changed in this PR

Adds shared AI-agent guidance for hipFile, including constraints from its integration with TheRock.

Changes:

  • Documents build, test, API, security, and linting practices.
  • Separates advisory rules from mandatory requirements.
  • Replaces CLAUDE.md guidance with an AGENTS.md include.
File Description
projects/​hipfile/​CLAUDE.md Delegates to the shared guidance.
projects/​hipfile/​AGENTS.md Adds hipFile-specific development instructions.

Review effort: Balanced

Comment thread projects/hipfile/AGENTS.md Resolved
Comment thread projects/hipfile/AGENTS.md Resolved
Comment thread projects/hipfile/AGENTS.md Resolved
@derobins
derobins merged commit cda0440 into develop Oct 21, 2026
44 of 46 checks passed
@derobins
derobins deleted the derobins/hipfile_agents_md branch October 21, 2026 17:27
systems-assistant Bot pushed a commit to ROCm/hipFile that referenced this pull request Oct 21, 2026
## Motivation

Agents need guidance when working in hipFile.

## Technical Details

Add an AGENTS.md, adapted from hipObject's, that gives AI coding agents
hipFile's build, test, API, and linting rules and the constraints that
come from building in TheRock. Rules the existing code doesn't pass yet
are marked advisory until it does. CLAUDE.md now just includes
AGENTS.md.

## Issue Tracking

JIRA ID: ROCM-28534

## Test Plan

Codespell passes

## Test Result

Success

## Submission Checklist

- [x] Look over the contributing guidelines at
https://github.com/ROCm/rocm-systems/blob/develop/CONTRIBUTING.md.

Co-authored-by: Claude <noreply@anthropic.com>
[rocm-systems] ROCm/rocm-systems#13875 (commit cda0440)
@systems-assistant

Copy link
Copy Markdown
Contributor

TheRock Submodule Bump Activity

Newest first

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants