Skip to content

HYPERFLEET-930 - docs: replace CLAUDE.md with AGENTS.md#146

Open
kuudori wants to merge 1 commit into
mainfrom
HYPERFLEET-930
Open

HYPERFLEET-930 - docs: replace CLAUDE.md with AGENTS.md#146
kuudori wants to merge 1 commit into
mainfrom
HYPERFLEET-930

Conversation

@kuudori
Copy link
Copy Markdown

@kuudori kuudori commented May 26, 2026

CLAUDE.md was a verbose mix of human workflow and agent instructions. AGENTS.md is agent-only: project context, document routing, format rules, validation, gotchas, and boundaries. CLAUDE.md now imports AGENTS.md via @-reference. Also fixes stale note in components/CLAUDE.md about sentinel.md lacking Trade-offs sections.

Summary

Test Plan

  • Unit tests added/updated
  • make test-all passes
  • make lint passes
  • Helm chart changes validated with make test-helm (if applicable)
  • Deployed to a development cluster and verified (if Helm/config changes)
  • E2E tests passed (if cross-component or major changes)

…agent guidelines

CLAUDE.md was a verbose mix of human workflow and agent instructions.
AGENTS.md is agent-only: project context, document routing, format
rules, validation, gotchas, and boundaries. CLAUDE.md now imports
AGENTS.md via @-reference. Also fixes stale note in
components/CLAUDE.md about sentinel.md lacking Trade-offs sections.
@openshift-ci openshift-ci Bot requested review from jsell-rh and rafabene May 26, 2026 20:01
@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented May 26, 2026

[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 rafabene 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
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 26, 2026

📝 Walkthrough

Walkthrough

This PR establishes centralized documentation governance for the HyperFleet architecture repository. A new AGENTS.md file defines the repository's documentation-only scope, required validation tooling (markdown, YAML, link checks), source-of-truth mappings by doc type, metadata and section requirements, and explicit contributor boundaries. The existing CLAUDE.md is consolidated from a full guidelines document into a single reference to AGENTS.md. A component-level documentation reference is updated to point to sentinel.md as a pattern example.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically summarizes the main change: replacing CLAUDE.md with AGENTS.md, which matches the primary content of this documentation refactoring PR.
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.
Description check ✅ Passed The PR description clearly describes the refactoring: replacing verbose CLAUDE.md with agent-only AGENTS.md and fixing a stale note in components/CLAUDE.md.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch HYPERFLEET-930

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@AGENTS.md`:
- Around line 1-4: Add the required YAML front-matter header at the very top of
AGENTS.md containing the fields "Status", "Owner", and "Last Updated"
(YYYY-MM-DD); ensure the header is enclosed in triple-dashes --- at start and
end, e.g. include Status: <value>, Owner: <name or team>, Last Updated:
<YYYY-MM-DD>, and place it before any other content so the document complies
with the doc-governance contract.

In `@CLAUDE.md`:
- Line 1: CLAUDE.md currently points to AGENTS.md but is missing the required
metadata header; add a top-of-file metadata block containing the fields
"Status:", "Owner:", and "Last Updated:" (with appropriate values) so the
document conforms to the guideline that every document—even pointer/alias
files—must include the mandatory metadata header; update CLAUDE.md (the pointer
file) to include these three fields as the first lines.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 6d69537f-d14e-4ddf-a205-1e547d30f76c

📥 Commits

Reviewing files that changed from the base of the PR and between 0ce35f7 and 2248ef8.

📒 Files selected for processing (3)
  • AGENTS.md
  • CLAUDE.md
  • hyperfleet/components/CLAUDE.md

Comment thread AGENTS.md
Comment thread CLAUDE.md
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.

1 participant