AGENTS.md: remind agents to keep tests and specs in sync#2006
Conversation
Co-authored-by: Cursor <cursoragent@cursor.com>
|
[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 DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
1 similar comment
|
[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 DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
📝 WalkthroughWalkthrough
ChangesContributor Guidelines Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (2)
AGENTS.md (2)
129-135: ⚡ Quick winConsider 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 containsREADME.mdplushow/andwhat/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
📒 Files selected for processing (1)
AGENTS.md
|
/override "Red Hat Konflux / e2e-console-pf6 / lightspeed-console" |
|
@kyoto: Overrode contexts on behalf of kyoto: Red Hat Konflux / e2e-console-pf6 / lightspeed-console DetailsIn response to this:
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. |
Summary by CodeRabbit
Release Notes
.ai/spec/when behavior, data flow, or structure changes.