Skip to content

OLS-0000: Standardize AGENTS.md content#1829

Open
joshuawilson wants to merge 2 commits into
openshift:mainfrom
joshuawilson:ols-0000-standardize-agents-md
Open

OLS-0000: Standardize AGENTS.md content#1829
joshuawilson wants to merge 2 commits into
openshift:mainfrom
joshuawilson:ols-0000-standardize-agents-md

Conversation

@joshuawilson

@joshuawilson joshuawilson commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Standardize AGENTS.md to include 4 mandatory sections: Specs, Commands, Conventions, Git and PR Workflow
  • Normalize file structure: AGENTS.md is the canonical file, CLAUDE.md is a symlink to it
  • Remove Risk Levels section (hook doesn't work in all cases)

Test plan

  • Verify AGENTS.md has all 4 mandatory sections
  • Verify CLAUDE.md is a symlink to AGENTS.md
  • Verify no Risk Levels section remains

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added a “Specs” section directing readers to the specifications overview and related documentation.
    • Removed the previously documented “Risk Levels” section and its associated references.

Add missing mandatory sections and remove Risk Levels section
to match the team-wide AGENTS.md template.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@openshift-ci-robot

Copy link
Copy Markdown

@joshuawilson: No Jira issue with key OLS-0000 exists in the tracker at https://redhat.atlassian.net.
Once a valid jira issue is referenced in the title of this pull request, request a refresh with /jira refresh.

Details

In response to this:

Summary

  • Standardize AGENTS.md to include 4 mandatory sections: Specs, Commands, Conventions, Git and PR Workflow
  • Normalize file structure: AGENTS.md is the canonical file, CLAUDE.md is a symlink to it
  • Remove Risk Levels section (hook doesn't work in all cases)

Test plan

  • Verify AGENTS.md has all 4 mandatory sections
  • Verify CLAUDE.md is a symlink to AGENTS.md
  • Verify no Risk Levels section remains

🤖 Generated with Claude Code

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci Bot requested review from blublinsky and bparees July 14, 2026 12:38
@openshift-ci

openshift-ci Bot commented Jul 14, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign raptorsun for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@coderabbitai

coderabbitai Bot commented Jul 14, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 9f3a7ba9-9969-4137-bab3-b1b023021d4c

📥 Commits

Reviewing files that changed from the base of the PR and between a2d9a77 and 440a8cd.

📒 Files selected for processing (1)
  • AGENTS.md

📝 Walkthrough

Walkthrough

AGENTS.md now directs readers to .ai/spec/ documentation and removes the previously documented Risk Levels section.

Changes

AGENTS.md guidance

Layer / File(s) Summary
Update AGENTS.md guidance
AGENTS.md
Adds a Specs subsection with links to the specification overview and removes the Risk Levels section.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: bparees, blublinsky

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: standardizing AGENTS.md content.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@xrajesh xrajesh 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.

Review: REQUEST_CHANGES (87/100)

Must-fix: Duplicate "Maintaining This Document" section

The diff replaces the ## Risk Levels section with a new ## Maintaining This Document heading + body. But ## Maintaining This Document already exists immediately after Risk Levels on main (line 170). The result is two consecutive identical sections:

## Maintaining This Document

Always suggest AGENTS.md edits when architectural, structural, or conventional changes are made to the codebase.

## Maintaining This Document

Always suggest AGENTS.md edits when architectural, structural, or conventional changes are made to the codebase.

Fix: Remove the replacement text — the intent is to delete Risk Levels and leave the existing Maintaining section untouched, so the replacement should be empty (just delete the ## Risk Levels block, don't substitute new text).


🤖 Reviewed by Claude Code

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@openshift-ci-robot

Copy link
Copy Markdown

@joshuawilson: No Jira issue with key OLS-0000 exists in the tracker at https://redhat.atlassian.net.
Once a valid jira issue is referenced in the title of this pull request, request a refresh with /jira refresh.

Details

In response to this:

Summary

  • Standardize AGENTS.md to include 4 mandatory sections: Specs, Commands, Conventions, Git and PR Workflow
  • Normalize file structure: AGENTS.md is the canonical file, CLAUDE.md is a symlink to it
  • Remove Risk Levels section (hook doesn't work in all cases)

Test plan

  • Verify AGENTS.md has all 4 mandatory sections
  • Verify CLAUDE.md is a symlink to AGENTS.md
  • Verify no Risk Levels section remains

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
  • Added a “Specs” section directing readers to the specifications overview and related documentation.
  • Removed the previously documented “Risk Levels” section and its associated references.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci

openshift-ci Bot commented Jul 15, 2026

Copy link
Copy Markdown

@joshuawilson: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

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.

3 participants