Skip to content

docs(hipblaslt): add PR title and JIRA ID conventions to AGENTS.md#8882

Merged
jaopaulolc merged 3 commits into
developfrom
users/jaopaulolc/docs-update-agents-pr-conventions
Jul 9, 2026
Merged

docs(hipblaslt): add PR title and JIRA ID conventions to AGENTS.md#8882
jaopaulolc merged 3 commits into
developfrom
users/jaopaulolc/docs-update-agents-pr-conventions

Conversation

@jaopaulolc

@jaopaulolc jaopaulolc commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

JIRA ID : AIHPBLAS-4017

Motivation

The hipBLASLt and TensileLite AGENTS.md files document the PR body template but do not mention the Conventional Commits title requirement or the mandatory JIRA ID reference. This causes AI agents (and humans) to create PRs that fail the automated bot policy checks, requiring a round-trip fix.

Technical Details

Updated both projects/hipblaslt/AGENTS.md and projects/hipblaslt/tensilelite/AGENTS.md to:

  • Document the required PR title format (type(scope): description) with the list of allowed types.
  • Document the required JIRA ID : ... line in the PR body.
  • Add JIRA ID : <JIRA key or N/A> to the body template itself.
  • Link to the Libraries PR Bot Policy FAQ for the full rule set.

The corresponding CLAUDE.md files already had this content; only the AGENTS.md files were out of date.

Test Plan

Docs only, no testing needed.

Test Result

N/A

Submission Checklist

Risk level

None. Documentation-only change to agent guidance files.

Document the Conventional Commits title format and JIRA ID requirement
in both hipblaslt and tensilelite AGENTS.md files, with a link to the
Libraries PR Bot Policy FAQ for the full set of automated PR checks.

JIRA ID : AIHPBLAS-3968
@jaopaulolc jaopaulolc force-pushed the users/jaopaulolc/docs-update-agents-pr-conventions branch from 2d075bb to 4880fc3 Compare June 26, 2026 23:30
@jaopaulolc jaopaulolc added the rocm:gemm algos Label to identify PRs of the GEMM Algorithms team. label Jun 26, 2026
@therock-pr-bot

therock-pr-bot Bot commented Jun 26, 2026

Copy link
Copy Markdown

✅ All Checks Passed — Ready for Review

Check Status Details
🌿 Branch Name ✅ Pass
📝 PR Title/Description ✅ Pass
Forbidden Files ✅ Pass
🧪 Unit Test ✅ Pass PR does not contain code files — Unit Test auto-passed
🔎 pre-commit ✅ Pass
🚫 Draft PR 🔜 To Be Enabled
🚩 Feature Flag 🔜 To Be Enabled
📊 Code Coverage 🔜 To Be Enabled
🤖 therock-pr-bot ✅ Pass

🎉 All checks passed! This PR is ready for review.

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

@therock-pr-bot

therock-pr-bot Bot commented Jun 26, 2026

Copy link
Copy Markdown

🎉 All checks passed! This PR is ready for review.

@jaopaulolc jaopaulolc merged commit 83cd82f into develop Jul 9, 2026
28 checks passed
@jaopaulolc jaopaulolc deleted the users/jaopaulolc/docs-update-agents-pr-conventions branch July 9, 2026 16:45
assistant-librarian Bot pushed a commit to ROCm/hipBLASLt that referenced this pull request Jul 9, 2026
docs(hipblaslt): add PR title and JIRA ID conventions to
 AGENTS.md (#8882)

JIRA ID : AIHPBLAS-4017

## Motivation

The hipBLASLt and TensileLite AGENTS.md files document the PR body
template but do not mention the Conventional Commits title requirement
or the mandatory JIRA ID reference. This causes AI agents (and humans)
to create PRs that fail the automated bot policy checks, requiring a
round-trip fix.

## Technical Details

Updated both `projects/hipblaslt/AGENTS.md` and
`projects/hipblaslt/tensilelite/AGENTS.md` to:
- Document the required PR title format (`type(scope): description`)
with the list of allowed types.
- Document the required `JIRA ID : ...` line in the PR body.
- Add `JIRA ID : <JIRA key or N/A>` to the body template itself.
- Link to the [Libraries PR Bot Policy
FAQ](https://github.com/ROCm/rocm-libraries/blob/develop/docs/LIBRARIES_PR_BOT_FAQ.md)
for the full rule set.

The corresponding CLAUDE.md files already had this content; only the
AGENTS.md files were out of date.

## Test Plan

Docs only, no testing needed.

## Test Result

N/A

## Submission Checklist

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

## Risk level

None. Documentation-only change to agent guidance files.
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.

2 participants