Skip to content

AGENTS.md: remind agents to keep tests and specs in sync#2006

Merged
openshift-merge-bot[bot] merged 1 commit into
openshift:mainfrom
kyoto:agents-keep-in-sync
Jun 1, 2026
Merged

AGENTS.md: remind agents to keep tests and specs in sync#2006
openshift-merge-bot[bot] merged 1 commit into
openshift:mainfrom
kyoto:agents-keep-in-sync

Conversation

@kyoto
Copy link
Copy Markdown
Member

@kyoto kyoto commented Jun 1, 2026

Summary by CodeRabbit

Release Notes

  • Documentation
    • Updated contributor guidelines with instructions for maintaining unit and end-to-end tests when making code changes.
    • Added guidance for updating spec files in .ai/spec/ when behavior, data flow, or structure changes.

Co-authored-by: Cursor <cursoragent@cursor.com>
@kyoto kyoto added lgtm Indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Jun 1, 2026
@openshift-ci openshift-ci Bot requested review from joshuawilson and syedriko June 1, 2026 04:52
@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented Jun 1, 2026

[APPROVALNOTIFIER] This PR is APPROVED

Approval requirements bypassed by manually added approval.

This pull-request has been approved by:

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

The pull request process is described 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

1 similar comment
@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented Jun 1, 2026

[APPROVALNOTIFIER] This PR is APPROVED

Approval requirements bypassed by manually added approval.

This pull-request has been approved by:

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

The pull request process is described 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

coderabbitai Bot commented Jun 1, 2026

📝 Walkthrough

Walkthrough

AGENTS.md is updated with new documentation sections that instruct contributors to keep unit tests and end-to-end tests current, and to update spec files in .ai/spec/ when behavior, data flow, or structure changes.

Changes

Contributor Guidelines Documentation

Layer / File(s) Summary
Test and spec file update guidance
AGENTS.md
New "Keeping tests up to date" section requires updating unit and end-to-end tests. New "Spec files" section directs contributors to .ai/spec/ files and requires updates when behavior, data flow, or structure changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A rabbit hops through the garden fair,
Updating docs with careful care—
"Keep tests bright, keep specs aligned,"
Wisdom for the coder-kind! 🐰✨

🚥 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 accurately describes the main change: adding reminders to AGENTS.md about keeping tests and specs synchronized with code changes.
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.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Copy link
Copy Markdown

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

🧹 Nitpick comments (2)
AGENTS.md (2)

129-135: ⚡ Quick win

Consider adding a spec file reminder to the PR checklist.

Since the new "Spec files" section instructs contributors to update spec files when behavior, data flow, or structure changes, consider adding a reminder to the PR checklist.

📋 Proposed addition to PR checklist
 ### PR checklist
 
 - Apply lint rules: `npm run lint-fix`
 - Update i18n strings: `npm run i18n`
 - Ensure build works: `npm run build`
 - Ensure unit tests pass: `npm run test:unit`
 - Ensure tests pass: `npm run test-headless`
+- Update spec files in `.ai/spec/` if behavior, data flow, or structure changed
🤖 Prompt for 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.

In `@AGENTS.md` around lines 129 - 135, Add a reminder to update spec files to the
PR checklist under the "### PR checklist" section in AGENTS.md: update the
checklist to include a bullet like "Update spec files when behavior, data flow,
or structure changes (see Spec files section)" so contributors remember to
modify spec files; locate the "### PR checklist" block and add the new bullet
alongside the existing lint/i18n/build/test steps.

117-121: Confirm .ai/spec/ exists for the “Spec files” guidance

.ai/spec/ is present in the repository and contains README.md plus how/ and what/ spec documents, so the reference in AGENTS.md (lines 117-121) is accurate. Optionally add a PR checklist reminder to update these spec files when behavior/data-flow/structure changes.

🤖 Prompt for 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.

In `@AGENTS.md` around lines 117 - 121, Confirm that `.ai/spec/` exists and
contains README.md plus `how/` and `what/` spec docs, then update AGENTS.md's
"Spec files" section to explicitly reference `.ai/spec/` (and optionally list
README.md, how/, what/) and add a short PR checklist reminder to update these
spec files when behavior, data flow, or structure changes; target the "Spec
files" heading in AGENTS.md and mention `.ai/spec/` and the spec artifacts to
make the guidance accurate.
🤖 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.

Nitpick comments:
In `@AGENTS.md`:
- Around line 129-135: Add a reminder to update spec files to the PR checklist
under the "### PR checklist" section in AGENTS.md: update the checklist to
include a bullet like "Update spec files when behavior, data flow, or structure
changes (see Spec files section)" so contributors remember to modify spec files;
locate the "### PR checklist" block and add the new bullet alongside the
existing lint/i18n/build/test steps.
- Around line 117-121: Confirm that `.ai/spec/` exists and contains README.md
plus `how/` and `what/` spec docs, then update AGENTS.md's "Spec files" section
to explicitly reference `.ai/spec/` (and optionally list README.md, how/, what/)
and add a short PR checklist reminder to update these spec files when behavior,
data flow, or structure changes; target the "Spec files" heading in AGENTS.md
and mention `.ai/spec/` and the spec artifacts to make the guidance accurate.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 2e58f7f4-3a9d-46d2-becc-55a8e0d07c80

📥 Commits

Reviewing files that changed from the base of the PR and between 163e863 and 476c96c.

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

@kyoto
Copy link
Copy Markdown
Member Author

kyoto commented Jun 1, 2026

/override "Red Hat Konflux / e2e-console-pf6 / lightspeed-console"

@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented Jun 1, 2026

@kyoto: Overrode contexts on behalf of kyoto: Red Hat Konflux / e2e-console-pf6 / lightspeed-console

Details

In response to this:

/override "Red Hat Konflux / e2e-console-pf6 / lightspeed-console"

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.

@openshift-merge-bot openshift-merge-bot Bot merged commit cf20d00 into openshift:main Jun 1, 2026
5 of 6 checks passed
@kyoto kyoto deleted the agents-keep-in-sync branch June 1, 2026 05:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant